# Install
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
This repository is based purely on notebooks and creates the
installation package following below described development procedure.
``` sh
pip install janusexp
```
## How to use this repo without code development
- example notebooks can be stored in `notebooks`, they then will be
added to the automatically generated documentation.
- I will soon add an example `example` notebook, so that you can see
the best layout for it. :)
## How to develop
### One time installation procedure for the required tools
1. change to environment you are developing in (conda/venv/whatever)
2. `pip install nbdev`
3. cd janus-nbexposure
4. `nbdev_install_hooks` \# to enable automatic cleaning of notebooks
at commit for this repo
5. `nbdev_install_quarto` to install the quarto documentation tools (or
install it yourself, see
https://quarto.org/docs/get-started/index.html )
1. This requires `sudo`, you can either trust it, I checked it, or
install the quarto tools yourself from above link, e.g. via a
tarball that doesn’t require sudo).
6. `pip install -e .` \# to install the source codes into your current
Python env in ‘editable mode’
### Regular develop procedure
1. Make changes in notebooks in the `notebooks folder only`, following
the rules of [nbdev](https://nbdev.fast.ai)
- Things we want to offer as an API for the tool users should go to
`notebooks/api` folder.
2. `nbdev_prepare` \# to export notebooks into python library, and
clean notebooks
3. If any new files were added: `git add *`
4. `git commit -m "commit message"`
5. `git push`
Raw data
{
"_id": null,
"home_page": "https://www.ict.inaf.it/gitlab/juice-janus/janus-nbexposure",
"name": "janusexp",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python",
"author": "Michael Aye and Livio Agostini and Luca Penasa",
"author_email": "michael.aye@fu-berlin.de",
"download_url": "https://files.pythonhosted.org/packages/e0/10/b3c752589b5da54065d96e3646adfb37a3484f0eb63f3d5713e80df8de0f/janusexp-0.1.0.tar.gz",
"platform": null,
"description": "# Install\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\nThis repository is based purely on notebooks and creates the\ninstallation package following below described development procedure.\n\n``` sh\npip install janusexp\n```\n\n## How to use this repo without code development\n\n- example notebooks can be stored in `notebooks`, they then will be\n added to the automatically generated documentation.\n - I will soon add an example `example` notebook, so that you can see\n the best layout for it. :)\n\n## How to develop\n\n### One time installation procedure for the required tools\n\n1. change to environment you are developing in (conda/venv/whatever)\n2. `pip install nbdev`\n3. cd janus-nbexposure\n4. `nbdev_install_hooks` \\# to enable automatic cleaning of notebooks\n at commit for this repo\n5. `nbdev_install_quarto` to install the quarto documentation tools (or\n install it yourself, see\n https://quarto.org/docs/get-started/index.html )\n 1. This requires `sudo`, you can either trust it, I checked it, or\n install the quarto tools yourself from above link, e.g.\u00a0via a\n tarball that doesn\u2019t require sudo).\n6. `pip install -e .` \\# to install the source codes into your current\n Python env in \u2018editable mode\u2019\n\n### Regular develop procedure\n\n1. Make changes in notebooks in the `notebooks folder only`, following\n the rules of [nbdev](https://nbdev.fast.ai)\n - Things we want to offer as an API for the tool users should go to\n `notebooks/api` folder.\n2. `nbdev_prepare` \\# to export notebooks into python library, and\n clean notebooks\n3. If any new files were added: `git add *`\n4. `git commit -m \"commit message\"`\n5. `git push`\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Exposure time calculation tools for JANUS instrument",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://www.ict.inaf.it/gitlab/juice-janus/janus-nbexposure"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "48833c82915a2347146123d7965405e741255348ce612a926e00accc905b3728",
"md5": "4bab7e1b6bc6d906d67bd84b960585f8",
"sha256": "8e86bf2c5470c9c976f407ef5c6b96a4721057b01b250199a5a97aef80138ff2"
},
"downloads": -1,
"filename": "janusexp-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bab7e1b6bc6d906d67bd84b960585f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 1789775,
"upload_time": "2023-10-12T03:28:59",
"upload_time_iso_8601": "2023-10-12T03:28:59.947811Z",
"url": "https://files.pythonhosted.org/packages/48/83/3c82915a2347146123d7965405e741255348ce612a926e00accc905b3728/janusexp-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e010b3c752589b5da54065d96e3646adfb37a3484f0eb63f3d5713e80df8de0f",
"md5": "7c638fd20089a6eb94e36922f98a148f",
"sha256": "7143feb64aa929bace6f34336915bda5c0b20432589dedc71d9797121d0f3f1a"
},
"downloads": -1,
"filename": "janusexp-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7c638fd20089a6eb94e36922f98a148f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 1795213,
"upload_time": "2023-10-12T03:29:03",
"upload_time_iso_8601": "2023-10-12T03:29:03.019463Z",
"url": "https://files.pythonhosted.org/packages/e0/10/b3c752589b5da54065d96e3646adfb37a3484f0eb63f3d5713e80df8de0f/janusexp-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-12 03:29:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "janusexp"
}
JSON