Metadata-Version: 2.1
Name: ITR-examples
Version: 1.0.1
Summary: Example code and user interface for the ITR project.
Keywords: Climate ITR Finance
Author-Email: Michael Tiemann <72577720+MichaelTiemannOSC@users.noreply.github.com>
License: Apache-2.0
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Project-URL: Homepage, https://github.com/os-climate/ITR-examples
Project-URL: Repository, https://github.com/os-climate/ITR-examples
Project-URL: Downloads, https://github.com/os-climate/ITR-examples/releases
Project-URL: Bug tracker, https://github.com/os-climate/ITR-examples/issues
Project-URL: Documentation, https://github.com/os-climate/ITR-examples/tree/main/docs
Project-URL: Source code, https://github.com/os-climate/ITR-examples
Requires-Python: >=3.9
Requires-Dist: ITR
Requires-Dist: dash==2.11.1
Requires-Dist: dash-bootstrap-components==1.4.2
Requires-Dist: diskcache==5.6.1
Requires-Dist: flask==2.2.5
Requires-Dist: jupyterlab==4.0.4
Requires-Dist: matplotlib==3.7.2
Requires-Dist: multiprocess==0.70.14
Description-Content-Type: text/markdown

# ITR-examples

Example data and user interface for the [ITR project](https://github.com/os-climate/ITR/)

## Getting started with the user interface:
If you use Anaconda environments, open an Anaconda prompt window, navigate to the root of the ITR release (ITR-develop) and run:
```
conda env create -f environment.yml
conda activate itr_ui
```

For virtual environments, open a command prompt/terminal window, navigate to the root of the ITR release and run
```
python3 -m venv itr_ui
```
On Unix or MacOS, activate the environment with
```
source itr_ui/bin/activate
```
On Windows, activate the environment with
```
itr_ui\Scripts\activate
```
Next, run:
```
python3 -m pip install --upgrade pip
pip install -r requirements.txt
pip install -e .
```

Now you are ready to change to the examples directory and run the tool:
```
cd examples
python3 ITR_UI.py
python3 ITR_UI.py "data/20230106 ITR V2 Sample Data.xlsx"
```

Note the python commands are ```python``` for windows and ``python3`` for linux/mac.  If no file is specified, the tool uses a default, small ITR dataset.  With a filename given, the ITR tool will load data from that dataset.  The 20230106 data template has over 120 companies across nearly a dozen sectors.

Finally, to access the user interface open a browser window and navigate to: [http://127.0.0.1:8050/](http://127.0.0.1:8050/)

## Jupyter notebooks
To work with notebooks from the 'examples' directory please register the kernel from your virtual environment
such that it is available in Jupyter. Kernels from Anaconda environments will be available by default. Replace
`<env_name>` in the following command by your environment name (`itr_ui` or `itr_env`) and run it in your environment.
```
python -m ipykernel install --user --name=<env_name>
```
Start Jupyter by activating your environment and running
```
jupyter-notebook
```

## Getting started for Contributors/Developers:
If you use Anaconda environments, open an Anaconda prompt window, navigate to the project directory and run:
```
conda env create -f environment.yml
conda activate itr_env
```

For virtual environments, open a command prompt/terminal window, navigate to the project directory and run:
```
python3 -m venv itr_env
```
On Unix or MacOS, activate the environment with
```
source itr_env/bin/activate
```
On Windows, activate the environment with
```
itr_env\Scripts\activate
```
Next, run:
```
python3 -m pip install --upgrade pip
pip install -r requirements.txt
pip install -e .[dev]
```

## User Interface Screenshot
![](docs/ITR_demo.gif)
