PyOpia
===============================
A Python Ocean Particle Image Analysis toolbox
# Documentation:
[](https://pyopia.readthedocs.io) [](https://pyopia.readthedocs.io/en/latest/?badge=latest)
[pyopia.readthedocs.io](https://pyopia.readthedocs.io)
# Current status:
- Under development. See/regester issues, [here](https://github.com/SINTEF/pyopia/issues)
----
# Development targets for PyOpia:
1) Allow nonfamiliar users to install and use PyOpia, and to contribute & commit code changes
2) Not hardware specific
3) Smaller dependency list than PySilCam -Eventual optional dependencies (e.g. for classification)
4) Can be imported by pysilcam or other hardware-specific tools
5) Work on a single-image basis (...primarily, with options for multiprocess to be considered later)
6) No use of settings/config files within the core code - pass arguments directly. Eventual use of settings/config files should be handled by high-level wrappers that provide arguments to functions.
7) Github workflows
8) Tests
Normal functions within PyOpia should:
1) take inputs
2) return new outputs
3) don't modify state of input
4) minimum possible disc IO during processing
## Contributions
We welcome additions and improvements to the code! We request that you follow a few guidelines. These are in place to make sure the code improves over time.
1. All code changes must be submitted as pull requests, either from a branch or a fork.
2. Good documentation of the code is needed for PyOpia to succeed and so please include up-to-date docstrings as you make changes, so that the auto-build on readthedocs is complete and useful for users. (A version of the new docs will complie when you make a pull request and a link to this can be found in the pull request checks)
3. All pull requests are required to pass all tests before merging. Please do not disable or remove tests just to make your branch pass the pull request.
4. All pull requests must be reviewed by a person. The benefits from code review are plenty, but we like to emphasise that code reviews help spreading the awarenes of code changes. Please note that code reviews should be a pleasant experience, so be plesant, polite and remember that there is a human being with good intentions on the other side of the screen.
5. All contributions are linted with flake8. We recommend that you run flake8 on your code while developing to fix any issues as you go. We recommend using autopep8 to autoformat your Python code (but please check the code behaviour is not affected by autoformatting before pushing). This makes flake8 happy, and makes it easier for us all to maintain a consistent and readable code base.
## Docstrings
Use the NumPy style in docstrings. See style guide [here](https://numpydoc.readthedocs.io/en/latest/format.html#documenting-classes)
# Installing
## For users
Users are expected to be familiar with Python. Please refer to the recommended installation instructions provided on the documentation pages, [here](https://pyopia.readthedocs.io/en/latest/intro.html#installing)
## For developers from source
Install [Python](https://github.com/conda-forge/miniforge/#download) version 3.10.
A prompt such as is provided by the [miniforge installation](https://github.com/conda-forge/miniforge/#download) may be used for the following:
1. Navigate to the folder where you want to install pyopia using the 'cd' command.
If you use git:
Download repository from github, and move into the new directory:
```bash
git clone https://github.com/SINTEF/pyopia.git
cd pyopia
```
For the next steps, you need to be located in the directory that contains the file 'environment.yml'.
1. (optional, but recommended) Create a virtual environment using the environment.yml. This will create an environment called pyopia, but with no dependencies installed. Dependencies are managed by poetry (in step 2):
```bash
conda env create -f environment.yml
```
and activate the environment:
```bash
conda activate pyopia
```
2. Install dependencies using poetry:
```bash
poetry install
```
Optional dependecies (for classification), can be installed like this:
```bash
poetry install --extras "classification"
```
or for arm/silicon systems:
```bash
poetry install --extras "classification-arm64"
```
Note: If poetry spends ages resolving dependencies, you can install a development environment with pip, like this: `pip install -e ".[classification]"` or for arm/silicon: `pip install -e ".[classification-arm64]"`
3. (optional) Run local tests:
```bash
poetry run pytest
```
#### Version numbering
The version number of PyOPIA is split into three sections: MAJOR.MINOR.PATCH
* MAJOR: Changes in high-level pipeline use and/or data output that are not backwards-compatible.
* MINOR: New features that are backwards-compatible.
* PATCH: Backwards-compatible bug fixes or enhancements to existing functionality
## Build docs locally
```
sphinx-apidoc -f -o docs/source docs/build --separate
sphinx-build -b html ./docs/ ./docs/build
```
----
# License
PyOpia is licensed under the BSD3 license. See LICENSE. All contributors should be recognised & aknowledged.
Raw data
{
"_id": null,
"home_page": "https://github.com/sintef/pyopia",
"name": "PyOPIA",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "Ocean, Particles, Imaging, Measurement, Size distribution",
"author": "Emlyn Davies",
"author_email": "emlyn.davies@sintef.no",
"download_url": "https://files.pythonhosted.org/packages/3e/6c/a1a23ebaed2cb35b3c700e8584ead4e8c696ec949ea29f57024eaabb6ce0/pyopia-2.8.2.tar.gz",
"platform": null,
"description": "PyOpia\n===============================\n\nA Python Ocean Particle Image Analysis toolbox\n\n# Documentation:\n\n[](https://pyopia.readthedocs.io) [](https://pyopia.readthedocs.io/en/latest/?badge=latest)\n\n[pyopia.readthedocs.io](https://pyopia.readthedocs.io)\n# Current status:\n\n- Under development. See/regester issues, [here](https://github.com/SINTEF/pyopia/issues)\n\n----\n# Development targets for PyOpia:\n\n1) Allow nonfamiliar users to install and use PyOpia, and to contribute & commit code changes\n2) Not hardware specific\n3) Smaller dependency list than PySilCam -Eventual optional dependencies (e.g. for classification)\n4) Can be imported by pysilcam or other hardware-specific tools\n5) Work on a single-image basis (...primarily, with options for multiprocess to be considered later)\n6) No use of settings/config files within the core code - pass arguments directly. Eventual use of settings/config files should be handled by high-level wrappers that provide arguments to functions.\n7) Github workflows\n8) Tests\n\nNormal functions within PyOpia should:\n\n1) take inputs\n2) return new outputs\n3) don't modify state of input\n4) minimum possible disc IO during processing\n\n## Contributions\n\nWe welcome additions and improvements to the code! We request that you follow a few guidelines. These are in place to make sure the code improves over time.\n\n1. All code changes must be submitted as pull requests, either from a branch or a fork.\n2. Good documentation of the code is needed for PyOpia to succeed and so please include up-to-date docstrings as you make changes, so that the auto-build on readthedocs is complete and useful for users. (A version of the new docs will complie when you make a pull request and a link to this can be found in the pull request checks)\n3. All pull requests are required to pass all tests before merging. Please do not disable or remove tests just to make your branch pass the pull request.\n4. All pull requests must be reviewed by a person. The benefits from code review are plenty, but we like to emphasise that code reviews help spreading the awarenes of code changes. Please note that code reviews should be a pleasant experience, so be plesant, polite and remember that there is a human being with good intentions on the other side of the screen.\n5. All contributions are linted with flake8. We recommend that you run flake8 on your code while developing to fix any issues as you go. We recommend using autopep8 to autoformat your Python code (but please check the code behaviour is not affected by autoformatting before pushing). This makes flake8 happy, and makes it easier for us all to maintain a consistent and readable code base.\n\n## Docstrings\n\nUse the NumPy style in docstrings. See style guide [here](https://numpydoc.readthedocs.io/en/latest/format.html#documenting-classes)\n\n# Installing\n\n## For users\n\nUsers are expected to be familiar with Python. Please refer to the recommended installation instructions provided on the documentation pages, [here](https://pyopia.readthedocs.io/en/latest/intro.html#installing)\n\n## For developers from source\n\nInstall [Python](https://github.com/conda-forge/miniforge/#download) version 3.10.\n\nA prompt such as is provided by the [miniforge installation](https://github.com/conda-forge/miniforge/#download) may be used for the following:\n\n1. Navigate to the folder where you want to install pyopia using the 'cd' command.\n\nIf you use git:\nDownload repository from github, and move into the new directory:\n\n```bash\ngit clone https://github.com/SINTEF/pyopia.git\ncd pyopia\n```\n\nFor the next steps, you need to be located in the directory that contains the file 'environment.yml'.\n\n1. (optional, but recommended) Create a virtual environment using the environment.yml. This will create an environment called pyopia, but with no dependencies installed. Dependencies are managed by poetry (in step 2):\n\n```bash\nconda env create -f environment.yml\n```\nand activate the environment:\n\n```bash\nconda activate pyopia\n```\n\n2. Install dependencies using poetry:\n\n```bash\npoetry install\n```\n\nOptional dependecies (for classification), can be installed like this:\n\n```bash\npoetry install --extras \"classification\"\n```\n\nor for arm/silicon systems:\n\n```bash\npoetry install --extras \"classification-arm64\"\n```\n\nNote: If poetry spends ages resolving dependencies, you can install a development environment with pip, like this: `pip install -e \".[classification]\"` or for arm/silicon: `pip install -e \".[classification-arm64]\"`\n\n\n3. (optional) Run local tests:\n\n```bash\npoetry run pytest\n```\n\n#### Version numbering\n\nThe version number of PyOPIA is split into three sections: MAJOR.MINOR.PATCH\n\n* MAJOR: Changes in high-level pipeline use and/or data output that are not backwards-compatible.\n* MINOR: New features that are backwards-compatible.\n* PATCH: Backwards-compatible bug fixes or enhancements to existing functionality\n\n## Build docs locally\n\n```\nsphinx-apidoc -f -o docs/source docs/build --separate\n\nsphinx-build -b html ./docs/ ./docs/build\n```\n\n----\n# License\n\nPyOpia is licensed under the BSD3 license. See LICENSE. All contributors should be recognised & aknowledged.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python Ocean Particle Image Analysis toolbox.",
"version": "2.8.2",
"project_urls": {
"Documentation": "https://pyopia.readthedocs.io",
"Homepage": "https://github.com/sintef/pyopia",
"Repository": "https://github.com/sintef/pyopia"
},
"split_keywords": [
"ocean",
" particles",
" imaging",
" measurement",
" size distribution"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02694f9ff9b9d4021f2388abec4df0369fe1c47cd2a6d933d2a605afa7c84783",
"md5": "90359da74a9a566da0544afba67c75dd",
"sha256": "130d45e40a1ea035ca08ad5ddf3d0291781d5a874be01b07286cff6c3929f054"
},
"downloads": -1,
"filename": "pyopia-2.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90359da74a9a566da0544afba67c75dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 62312,
"upload_time": "2024-11-04T08:15:35",
"upload_time_iso_8601": "2024-11-04T08:15:35.360458Z",
"url": "https://files.pythonhosted.org/packages/02/69/4f9ff9b9d4021f2388abec4df0369fe1c47cd2a6d933d2a605afa7c84783/pyopia-2.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e6ca1a23ebaed2cb35b3c700e8584ead4e8c696ec949ea29f57024eaabb6ce0",
"md5": "8ec974201d739d69b318d58b3a078fd1",
"sha256": "d76abe54e23f9a621a407a22128bf77a506cb5433932cb8d8888e72b4b011eaa"
},
"downloads": -1,
"filename": "pyopia-2.8.2.tar.gz",
"has_sig": false,
"md5_digest": "8ec974201d739d69b318d58b3a078fd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 54831,
"upload_time": "2024-11-04T08:15:38",
"upload_time_iso_8601": "2024-11-04T08:15:38.118541Z",
"url": "https://files.pythonhosted.org/packages/3e/6c/a1a23ebaed2cb35b3c700e8584ead4e8c696ec949ea29f57024eaabb6ce0/pyopia-2.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 08:15:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sintef",
"github_project": "pyopia",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyopia"
}
JSON
