Skip to content

Commit bac3af3

Browse files
JohnVolkJohnVolk
committed
updates to docs, packaging
2 parents 77c43c4 + 88f12cc commit bac3af3

55 files changed

Lines changed: 97 additions & 10920 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
# builds for uploading to PyPI
1313
dist/
14-
build/
14+
./build/
1515
prms_python.egg-info/
1616

1717
venv

‎CHANGELOG.rst‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
Change log
2+
**********
3+
4+
Version 1.0.1
5+
=============
6+
7+
Substantial improvements and updates to online documentation. Renamed two util
8+
module functions to align with PEP style conventions specifically:
9+
``Kolmogorov_Smirnov`` became ``kolmogorov_smirnov`` and ``calc_emp_CDF``
10+
became ``calc_emp_cdf``, also renamed ``util.load_data_file`` to
11+
``util.load_data`` for consistency with ``util.load_statvar``. Name changes
12+
are backwards compatible.
13+
14+
Bug Fixes
15+
---------
16+
17+
* Fix `prmspy` script errors after prms-python installation with Python 2
18+
19+
Version 1.0.0
20+
=============
21+
22+
Stable version and first numbered release on PyPI. All functionality tested
23+
and passed on multiple platforms using several PRMS models.
24+
25+
Major submodules, classes and functions
26+
---------------------------------------
27+
28+
* data
29+
- Data
30+
* parameters
31+
- Parameters, modify_params
32+
* simulation
33+
- Simulation, SimulationSeries
34+
* scenario
35+
- Scenario, ScenarioSeries
36+
* optimizer
37+
- Optimizer, OptimizationResult, resample_param
38+
* util
39+
- load_statvar, nash_sutcliffe, and others
40+
41+
This version also includes the command line interface script "`prmspy`".
42+
Ongoing work on Docs website, includes mostly up-to-date Jupyter notebook
43+
examples.
44+
45+
Version 0.1.0
46+
=============
47+
48+
First numbered version, was not setup for installation using PyPI. Many changes
49+
occured for initial development under this version which were not released.
50+

license renamed to LICENSE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1+
<<<<<<< HEAD:license
12
Copyright (c) 2016-2019 John Volk and Matthew Turner
3+
=======
4+
Copyright (c) 2016-2018 John Volk and Matt Turner
5+
>>>>>>> 88f12cc75c3e6682f81d3724fb5681e747481b1e:LICENSE.md
26
All rights reserved.
37

48
Redistribution and use in source and binary forms, with or without

‎MANIFEST.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
include license
1+
include LICENSE.md
22
include environment.yml
33
graft notebooks

‎README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,8 @@ nosetests -v
120120

121121
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/PRMS-Python/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.
122122

123-
<!--- commented until paper accepted
124-
125123
## Citing PRMS-Python
126124

127-
If you use PRMS-Python for published work we ask that you cite it as follows:
125+
If you use PRMS-Python for published work we ask that you please cite the [PRMS-Python manuscript](https://www.sciencedirect.com/science/article/pii/S1364815218308004) as follows:
128126

129-
-->
127+
Volk, J. M., & Turner, M. A. (2019). PRMS-Python: A Python framework for programmatic PRMS modeling and access to its data structures. Environmental Modelling & Software, 114, 152–165. https://doi.org/10.1016/J.ENVSOFT.2019.01.006

‎docs/build/doctrees/api.doctree‎

-318 KB
Binary file not shown.

‎docs/build/doctrees/cli.doctree‎

-17.8 KB
Binary file not shown.

‎docs/build/doctrees/environment.pickle‎

-5.51 MB
Binary file not shown.

‎docs/build/doctrees/index.doctree‎

-12.1 KB
Binary file not shown.

‎docs/build/doctrees/tutorial.doctree‎

-79.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)