Skip to main content

Example code and user interface for the ITR project.

Project description

ITR-examples

Example data and user interface for the ITR project

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/

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

itr_examples-1.0.1.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

itr_examples-1.0.1-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file itr_examples-1.0.1.tar.gz.

File metadata

  • Download URL: itr_examples-1.0.1.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for itr_examples-1.0.1.tar.gz
Algorithm Hash digest
SHA256 927aa9f33cd556c1598903516ddb03709fdcbfd012ccb0ac8dc578156fce04d9
MD5 c3add15d963d37ce1fd1e7f3486f3fc2
BLAKE2b-256 29bfa45b731434df31aa8d66d8932dd69eed22f1cc3097ea66e5415da57f0a13

See more details on using hashes here.

File details

Details for the file itr_examples-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: itr_examples-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for itr_examples-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7dffde1b99f0b7264bc8bb74db12dd0554c1ecad72e081aa937ff6f43416f7bf
MD5 1b8c4ae05877012b04bc5b07bd0898e9
BLAKE2b-256 9ff2e4d98ffa3ad5d1d5d11375ff8c8298330d40a335e8c7cf82677c36ca5b57

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page