| Name | ITR-examples JSON |
| Version |
1.1.5
JSON |
| download |
| home_page | None |
| Summary | Example code and user interface for the ITR project. |
| upload_time | 2024-04-24 15:37:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.9 |
| license | Apache-2.0 |
| keywords |
climate
itr
finance
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# 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
To install the tool (or upgrade to the latest release) run:
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade itr-examples
Now you are ready to run the tool:
itr-ui
You can also load specific content using the syntax:
itr-ui "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 haven't done so already, follow the installation instructions above.
Make sure you have sourced the virtual environment using:
source itr_env/bin/activate
...Or under Windows:
itr_env\Scripts\activate
The commands below will upgrade to the latest release and install the components necessary for development:
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade itr-examples
pip install -e .[dev]
Raw data
{
"_id": null,
"home_page": null,
"name": "ITR-examples",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "Climate, ITR, Finance",
"author": null,
"author_email": "Michael Tiemann <72577720+MichaelTiemannOSC@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/58/e9/b7be45d0ae44f5dd0fdeaee47aa1a52c91527519d7b7f01dc749aab1f415/itr_examples-1.1.5.tar.gz",
"platform": null,
"description": "# ITR-examples\n\nExample data and user interface for the [ITR project](https://github.com/os-climate/ITR/)\n\n## Getting started with the user interface\n\nIf you use Anaconda environments, open an Anaconda prompt window, navigate to the root of the ITR release (ITR-develop) and run:\n\n conda env create -f environment.yml\n conda activate itr_ui\n\nFor virtual environments, open a command prompt/terminal window, navigate to the root of the ITR release and run\n\n python3 -m venv itr_ui\n\nOn Unix or MacOS, activate the environment with\n\n source itr_ui/bin/activate\n\nOn Windows, activate the environment with\n\n itr_ui\\Scripts\\activate\n\nTo install the tool (or upgrade to the latest release) run:\n\n python3 -m pip install --upgrade pip\n python3 -m pip install --upgrade itr-examples\n\nNow you are ready to run the tool:\n\n itr-ui\n\nYou can also load specific content using the syntax:\n\n itr-ui \"data/20230106 ITR V2 Sample Data.xlsx\"\n\nNote 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.\n\nFinally, to access the user interface open a browser window and navigate to: [http://127.0.0.1:8050/](http://127.0.0.1:8050/)\n\n## Jupyter notebooks\n\nTo work with notebooks from the 'examples' directory please register the kernel from your virtual environment\nsuch that it is available in Jupyter. Kernels from Anaconda environments will be available by default. Replace\n`<env_name>` in the following command by your environment name (`itr_ui` or `itr_env`) and run it in your environment.\n\n python -m ipykernel install --user --name=<env_name>\n\nStart Jupyter by activating your environment and running\n\n jupyter-notebook\n\n## Getting started for Contributors/Developers\n\nIf you haven't done so already, follow the installation instructions above.\n\nMake sure you have sourced the virtual environment using:\n\n source itr_env/bin/activate\n\n...Or under Windows:\n\n itr_env\\Scripts\\activate\n\nThe commands below will upgrade to the latest release and install the components necessary for development:\n\n python3 -m pip install --upgrade pip\n python3 -m pip install --upgrade itr-examples\n pip install -e .[dev]\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Example code and user interface for the ITR project.",
"version": "1.1.5",
"project_urls": {
"Bug tracker": "https://github.com/os-climate/ITR-examples/issues",
"Documentation": "https://github.com/os-climate/ITR-examples/tree/main/docs",
"Downloads": "https://github.com/os-climate/ITR-examples/releases",
"Homepage": "https://github.com/os-climate/ITR-examples",
"Repository": "https://github.com/os-climate/ITR-examples",
"Source code": "https://github.com/os-climate/ITR-examples"
},
"split_keywords": [
"climate",
" itr",
" finance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e6d197743c12bdd6c9c3358b77324570cfdaab539cb6532069c3b4d27563d2ee",
"md5": "5d6ba9ea97e9d1087b016b888b6bb590",
"sha256": "2dfef2ef53560574495c9243cf851aba282812101c99c96735d876e36ebee7a9"
},
"downloads": -1,
"filename": "itr_examples-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d6ba9ea97e9d1087b016b888b6bb590",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 1057360,
"upload_time": "2024-04-24T15:37:40",
"upload_time_iso_8601": "2024-04-24T15:37:40.459284Z",
"url": "https://files.pythonhosted.org/packages/e6/d1/97743c12bdd6c9c3358b77324570cfdaab539cb6532069c3b4d27563d2ee/itr_examples-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58e9b7be45d0ae44f5dd0fdeaee47aa1a52c91527519d7b7f01dc749aab1f415",
"md5": "46a19347aa5fd317fb6064f0a0b053e2",
"sha256": "0551ddfd34685fc8615e1a21ea19a409908705724bb87a444110e50ca0856e3e"
},
"downloads": -1,
"filename": "itr_examples-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "46a19347aa5fd317fb6064f0a0b053e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 1056472,
"upload_time": "2024-04-24T15:37:42",
"upload_time_iso_8601": "2024-04-24T15:37:42.293719Z",
"url": "https://files.pythonhosted.org/packages/58/e9/b7be45d0ae44f5dd0fdeaee47aa1a52c91527519d7b7f01dc749aab1f415/itr_examples-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 15:37:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "os-climate",
"github_project": "ITR-examples",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "itr-examples"
}
