README file for Sediment Accumulation Risk Model (SARM) Python toolbox (v1.0).

General Information
1. Title of dataset.
Sediment Accumulation Risk Model (SARM) Python toolbox (v1.0)

2. Date of deposit
23/11/2023

3. PI / Author (or equivalent)
Cat Hudson and Martin Schaefer

4. Project
N/A

5. Funding information
No funding

6. Data collection information
i) Date/time period of collection:
Python toolbox developed September to November 2023. Sediment Accumulation Risk Model (SARM) v1.0 finalised 22nd November 2023
ii) Geographic location of collection (if applicable):
N/A

Sharing & Access (only relevant if sharing data)
7. State licence(s) for use:
CC BY 4.0

8. Any restrictions:
N/A

9. Request for Access contact (if applicable):
N/A

10. Information on outputs/publications that cite or use the data:
The Python Toolbox will be cited in a manuscript submission to Environmental Research journal - submission for peer review anticipated on 24/11/2023

Data Overview
11. List data files:
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.pyt
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.pyt.xml
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.ScriptOne.pyt.xml
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.ScriptTwo.pyt.xml
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.ScriptThree.pyt.xml
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.ScriptFour.pyt.xml
Sediment Accumulation Risk Model (SARM) v1.0 - User Guide.pdf

12. Explain any relationships between files:
The XML files contain metadata and configuration information for the toolbox and the four tools within the toolbox. XML files should be downloaded and stored in the same location as the PYT file. The user guide (.pdf file) is a document explaining how to use the Python toolbox (.pyt file), including a list of prerequisites steps, inputs and outputs.

13. For each file
i) Description of content:
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.pyt: A Python toolbox designed for use in ESRI ArcGIS Pro v3 software. It has been developed for users to generate erodibility-weighted accumulation within a subcatchment location, test different accumulation thresholds for generating output pathways, and calculate sediment accumulation risk for pathway points. The current version of the model is v1.0 (November 2023).
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.pyt.xml: an XML document that contains metadata and configuration information about the Python toolbox.
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.ScriptOne.pyt.xml: an XML document that stores metadata and configuration information for the ScriptOne tool.
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.ScriptTwo.pyt.xml: an XML document that stores metadata and configuration information for the ScriptTwo tool.
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.ScriptThree.pyt.xml: an XML document that stores metadata and configuration information for the ScriptThree tool.
Sediment_Accumulation_Risk_Model_SARM_Toolbox_v1.0.ScriptFour.pyt.xml: an XML document that stores metadata and configuration information for the ScriptFour tool.
Sediment Accumulation Risk Model (SARM) v1.0 - User Guide.pdf: A document to assist users with running the Sediment Accumulation Risk Model (SARM) Python toolbox in ESRI ArcGIS Pro v3.

ii) If not embedded within the file(s) provide variable metadata, missing data data definitions etc.:
N/A.
iii) Details of any specialised formats or abbreviations:
N/A.

Methodological Information
14. Link to methodology description / or brief description of method.
A description of the methodology used in the Python toolbox will be outlined in the submitted manuscript.

15. Describe any quality assurance procedures:
The Python toolbox has been rigorously tested by the authors in a variety of test sites, and improvements made to enhance user experience.

16. Any specific information required to interpret/use the data e.g. specific instrumentation/software information:
Sediment Accumulation Risk Model (SARM) v1.0 - User Guide.pdf has been created to assist users with running the Python toolbox. Users will require ESRI ArcGIS Pro v3 software.