You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-11Lines changed: 24 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,14 @@
1
1
# PRMS-Python
2
2
3
-
PRMS-Python provides a Python interface to PRMS data files and for running
4
-
PRMS simulations. This module tries to improve the management of PRMS simulation
5
-
data while also providing useful "pythonic" tools to do scenario-based PRMS
6
-
simulations. By "scenario-based" modeling we mean, for example, parameter
7
-
sensitivity analysis, where each "scenario" is an iterative perturbation of
3
+
PRMS-Python provides a Python interface to PRMS data files and manages
4
+
PRMS simulations. This module aims to improve the efficiency of PRMS
5
+
simulations while providing "pythonic" tools to do scenario-based PRMS
6
+
simulations. By "scenario-based" we mean testing model hypotheses
7
+
associated with model inputs, outputs, and model structure. For example,
8
+
parameter sensitivity analysis, where each "scenario" is an iterative perturbation of
8
9
one or many parameters. Another example "scenario-based" modeling exercise would
9
10
be climate scenario modeling: what will happen to modeled outputs if the
10
-
input meteorological data were to change?
11
+
input meteorological data were to change?
11
12
12
13
13
14
## Installation
@@ -23,6 +24,11 @@ then
23
24
```
24
25
pip install --editable .
25
26
```
27
+
## Usage and documentation
28
+
29
+
We reccomend starting with the ["getting started"](https://github.com/JohnVolk/PRMS-Python/blob/master/notebooks/getting_started.ipynb)
30
+
Jupyter notebook for file structure rules that PRMS-Python uses and then
31
+
moving on to other example notebooks in the [`notebooks` directory](https://github.com/JohnVolk/PRMS-Python/tree/master/notebooks). Online documentation is also available [here](https://prms-python.github.io/docs/).
26
32
27
33
## Building documentation
28
34
@@ -79,11 +85,6 @@ git fetch origin \
79
85
80
86
-->
81
87
82
-
## Usage
83
-
84
-
Please read the [Online Documentation](https://prms-python.github.io/docs) and view
85
-
the included Jupyter notebooks for further documentation and examples.
86
-
87
88
88
89
## Unit tests
89
90
@@ -92,3 +93,15 @@ I run them using nose but that's not required. From the root repo directory
92
93
```
93
94
nosetests -v
94
95
```
96
+
97
+
## Contribute
98
+
99
+
We welcome anyone seriously interested in contributing to PRMS-Python to do so in anyway they see fit. If you are not sure where to begin you can look for current issues or submit a new issue [here](https://github.com/JohnVolk/PRMS-Python/issues). You may also [fork](https://help.github.com/articles/fork-a-repo/) PRMS-Python and submit a pull request if you would like to offer your direct changes to the package.
100
+
101
+
<!--- commented until paper accepted
102
+
103
+
## Citing PRMS-Python
104
+
105
+
If you use PRMS-Python for published work we ask that you cite it as follows:
0 commit comments