Skip to content

Commit c32ecc0

Browse files
JohnVolkJohnVolk
committed
update distribution info
1 parent 217c053 commit c32ecc0

3 files changed

Lines changed: 35 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
PRMS-Python provides a Python interface to PRMS data files and manages
44
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
9-
one or many parameters. Another example "scenario-based" modeling exercise would
10-
be climate scenario modeling: what will happen to modeled outputs if the
11-
input meteorological data were to change?
5+
workflows by giving access to PRMS data structures while providing
6+
"pythonic" tools to do scenario-based PRMS simulations. By
7+
"scenario-based" we mean testing model hypotheses associated with model
8+
inputs, outputs, and model structure. For example, parameter sensitivity
9+
analysis, where each "scenario" is an iterative perturbation of one or
10+
many parameters. Another example "scenario-based" modeling exercise
11+
would be climate scenario modeling: what will happen to modeled outputs
12+
if the input meteorological data were to change?
13+
1214

1315

1416
## Installation

‎prms_python/__init__.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
"""
2+
PRMS-Python provides a Python interface to PRMS data files and manages
3+
PRMS simulations. This module aims to improve the efficiency of PRMS
4+
workflows by giving access to PRMS data structures while providing
5+
"pythonic" tools to do scenario-based PRMS simulations. By
6+
"scenario-based" we mean testing model hypotheses associated with model
7+
inputs, outputs, and model structure. For example, parameter sensitivity
8+
analysis, where each "scenario" is an iterative perturbation of one or
9+
many parameters. Another example "scenario-based" modeling exercise
10+
would be climate scenario modeling: what will happen to modeled outputs
11+
if the input meteorological data were to change?
12+
13+
"""
14+
15+
__name__ = 'prms-python'
16+
__author__ = 'John Volk and Matthew Turner'
17+
__version__ = '1.0.0'
18+
119
from .data import Data
220
from .optimizer import Optimizer, OptimizationResult
321
from .parameters import Parameters, modify_params

‎setup.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
'License :: OSI Approved :: BSD3 License',
1414
'Programming Language :: Python :: 2.7',
1515
'Programming Language :: Python :: 3.4',
16+
'Programming Language :: Python :: 3.5',
17+
'Programming Language :: Python :: 3.6',
18+
'Programming Language :: Python :: 3.7',
1619
'Environment :: Console',
1720
'Development Status :: 4 - Beta',
1821
'Topic :: Scientific/Engineering',
@@ -21,13 +24,16 @@
2124

2225
setup(
2326
name='prms-python',
24-
description='''
27+
description='A Python package with tools for the PRMS hydrologic model.',
28+
long_description='''
2529
PRMS-Python provides a Python interface to PRMS data files and manages PRMS simulations. This module aims to improve the efficiency of PRMS simulations while providing "pythonic" tools to do scenario-based PRMS simulations. By "scenario-based" we mean testing model hypotheses associated with model inputs, outputs, and model structure. For example, parameter sensitivity analysis, where each "scenario" is an iterative perturbation of one or many parameters. Another example "scenario-based" modeling exercise would be climate scenario modeling: what will happen to modeled outputs if the input meteorological data were to change?
2630
''',
2731
author='John Volk and Matthew Turner',
2832
author_email='jmvolk@unr.edu',
2933
license='BSD3',
30-
version='0.1',
34+
version='1.0.0',
35+
url='https://github.com/JohnVolk/PRMS-Python',
36+
platforms=['Windows','Linux','Mac OS X'],
3137
classifiers=classifiers,
3238
py_modules=['prms_python'],
3339
install_requires=requires,

0 commit comments

Comments
 (0)