diff --git a/README.rst b/README.rst index 82bf31743..a0d3b23d8 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ -GeoJSON / Modelica Translator -============================= +GeoJSON to Modelica Translator +------------------------------ .. image:: https://travis-ci.org/urbanopt/geojson-modelica-translator.svg?branch=develop :target: https://travis-ci.org/urbanopt/geojson-modelica-translator @@ -14,7 +14,7 @@ Description The GeoJSON / Modelica Translator is a one-way trip from GeoJSON with a well-defined property's schema to a set of Modelica buildings. The project will eventually allow multiple paths to model the loads portion of the building models; however, the initial implementation uses the Teaser library to create the RC models with the appropriate coefficients. Getting Started -*************** +--------------- The GeoJSON / Modelica Translator is still in early alpha-phase development and the functionality is limited. Currently, the proposed approach for getting started is to run the following @@ -47,6 +47,10 @@ To run pre-commit against the files without calling git commit, then run the fol pre-commit run --all-files +Releasing to PyPi +----------------- + + Modules ******* @@ -145,20 +149,14 @@ There is managed task to automatically pull updated GeoJSON schemas from the `ur The developer should run the test suite after updating the schemas to ensure that nothing appears to have broken. Note that the tests do not cover all of the properties and should not be used as proof that everything works with the updated schemas. -Templating of Connectivity -************************** +Templating Diagram +------------------ .. image:: ./ConnectionTemplate.jpg -Updating Copyrights -******************* - - Todos ----- * handle weather in Teaser -* Create a Script directory in the modelica_path class * Validate remaining schema objects * AHU example -* runnable example diff --git a/setup.cfg b/setup.cfg index 1937e4b34..c40e440a8 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,8 @@ # content of pytest.ini or tox.ini # setup.cfg files should use [tool:pytest] section instead +[metadata] +description-file = README.rst + [tool:pytest] addopts = --cov geojson_modelica_translator --cov-report term-missing diff --git a/setup.py b/setup.py index 7ff1c0eed..1788be162 100755 --- a/setup.py +++ b/setup.py @@ -51,7 +51,7 @@ name="GeoJSON Modelica Translator", version="0.1.0", description="Package for converting GeoJSON to Modelica models for Urban Scale Analyses.", - long_description=readme, + long_description="Package for converting GeoJSON to Modelica models for Urban Scale Analyses.", author="Nicholas Long", author_email="nicholas.long@nrel.gov", url="https://github.com/urbanopt/geojson_modelica_translator",