npr99/pyincore

pyIncore is a component of IN-CORE. It is a python package consisting of two primary components: 1) a set of service classes to interact with the IN-CORE web services, and 2) IN-CORE analyses . The pyIncore allows users to apply various hazards to infrastructure in selected areas, propagating the effect of physical infrastructure damage and loss of functionality to social and economic impacts.

pyIncore documentation

pyIncore documentation which is built using Python Sphinx package.

Installation

Clone the code from pyincore repository git repository.

Building and running Sphinx in Docker container

Install Docker Desktop for your OS and change directory to your local branch pyincore folder.

1. Build container

   docker build -f Dockerfile -t doc/pyincore .
   

   The container's name is pyincore_docs in this example.

2. Run docker

   docker run -ti --rm -p 8000:80 doc/pyincore
   

   Optional flag, --name sets container's name to doctest under which it appears in Docker Desktop.

3. Run html pages in your local browser (you might see the nginx main page first)

   http://localhost:8000/doc/pyincore/
   

Running Sphinx directly in your environment

1. Install required packages. Currently sphinx, a Python package for building documentation and sphinx_rtd_theme, a theme used in this documentation and other packages. See section 4. for the full list.

2. We recommend using virtual environments, conda (preferred) or virtualenv for Python 3.7+. for managing Python environments.
   In case of conda, the package management and deployment tool is called anaconda. Create the environment from the terminal at the project folder (called pyincore_docs here) and activate it:

   conda create -n pyincore_docs python=3.7
   conda activate pyincore_docs
   

   or

   virtualenv --python=python3.7 pyincore_docs
   source venv/bin/activate
   

3. Install required packages individually if necessary. Use conda again or you can also use pip:

   conda install sphinx
   conda install sphinx_rtd_theme
   

   or (global install for all users drop the --user flag)

   python3 -m pip install sphinx --user
   python3 -m pip install sphinx_rtd_theme --user
   

4. From the terminal at the project folder (pyincore/docs) run:

   sphinx-build -b html source build
   

   after that you should be able to run (clean deletes content of the build folder) :

   make clean
   make html
   

5. Open index.html from build/html directory in a browser.