.. modelparameters documentation master file, created by sphinx-quickstart on Sat Sep 29 21:36:23 2018. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to modelparameters's documentation! =========================================== Modelparameters is a lightweight library to declare nested parameters in Python, and can be used as a module for providing parameter structure for physical models. It is mainly developed as a tool for `gotran `_, but certainly not limited to that. .. code:: python from modelparameters import ScalarParam # Define the gravitational acceleration g = ScalarParam(9.81, name="g", unit="m/s**2", description="gravitational acceleration") # Define the time (in milliseconds) t = ScalarParam(100.0, unit="ms", description="Time spent") # Compute the distance travelled in free fall s = 0.5 * g * t**2 print(s) Output: .. code:: shell 49050.0 ∈ [-∞, ∞] Demos ----- Will come later! Installation ------------ You can install modelparameters either with `pip `_: .. code:: shell pip install modelparameters or if you want the latest features, you can install from `source `_: .. code:: shell pip install git+https://finsberg@bitbucket.org/finsberg/modelparameters.git Source code ----------- Modelparmeters is orginally developed by Johan Hake, and the original source code can be found in his `repoistory `_. The current maintained version can be foud `here `_. Contributors ------------ The main contributors are * Henrik Finsberg (henriknf@simula.no) * Johan Hake (hake.dev@gmail.com) License ------- GNU LGPLv3 .. toctree:: :maxdepth: 4 :caption: Programmers reference modelparameters .. toctree:: :maxdepth: 2 :caption: Contents: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`