| Name | pyrolite JSON |
| Version |
0.3.5.post0
JSON |
| download |
| home_page | |
| Summary | Tools for geochemical data analysis. |
| upload_time | 2024-02-26 05:55:36 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | CSIRO Open Source Software Licence Agreement (Variation of the BSD/MIT License) Copyright (C) 2018 CSIRO Commonwealth Scientific and Industrial Research Organisation ABN 41 687 119 230. All rights reserved. CSIRO is willing to grant you a licence to pyrolite on the following terms, except where otherwise indicated for third party material. Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of CSIRO nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of CSIRO. As a condition of this licence, you agree that where you make any adaptations, modifications, further developments, or additional features available to CSIRO or the public in connection with your access to the Software, you do so on the terms of the BSD 3-Clause Licence template. A copy can be found at: http://opensource.org/licenses/BSD-3-Clause EXCEPT AS EXPRESSLY STATED IN THIS AGREEMENT AND TO THE FULL EXTENT PERMITTED BY APPLICABLE LAW, THE SOFTWARE IS PROVIDED "AS-IS". CSIRO MAKES NO REPRESENTATIONS, WARRANTIES OR CONDITIONS OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY REPRESENTATIONS, WARRANTIES OR CONDITIONS REGARDING THE CONTENTS OR ACCURACY OF THE SOFTWARE, OR OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, THE ABSENCE OF LATENT OR OTHER DEFECTS, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. TO THE FULL EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL CSIRO BE LIABLE ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, IN AN ACTION FOR BREACH OF CONTRACT, NEGLIGENCE OR OTHERWISE) FOR ANY CLAIM, LOSS, DAMAGES OR OTHER LIABILITY HOWSOEVER INCURRED. WITHOUT LIMITING THE SCOPE OF THE PREVIOUS SENTENCE THE EXCLUSION OF LIABILITY SHALL INCLUDE: LOSS OF PRODUCTION OR OPERATION TIME, LOSS, DAMAGE OR CORRUPTION OF DATA OR RECORDS; OR LOSS OF ANTICIPATED SAVINGS, OPPORTUNITY, REVENUE, PROFIT OR GOODWILL, OR OTHER ECONOMIC LOSS; OR ANY SPECIAL, INCIDENTAL, INDIRECT, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES, ARISING OUT OF OR IN CONNECTION WITH THIS AGREEMENT, ACCESS OF THE SOFTWARE OR ANY OTHER DEALINGS WITH THE SOFTWARE, EVEN IF CSIRO HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH CLAIM, LOSS, DAMAGES OR OTHER LIABILITY. APPLICABLE LEGISLATION SUCH AS THE AUSTRALIAN CONSUMER LAW MAY APPLY REPRESENTATIONS, WARRANTIES, OR CONDITIONS, OR IMPOSE OBLIGATIONS OR LIABILITY ON CSIRO THAT CANNOT BE EXCLUDED, RESTRICTED OR MODIFIED TO THE FULL EXTENT SET OUT IN THE EXPRESS TERMS OF THIS CLAUSE ABOVE "CONSUMER GUARANTEES". TO THE EXTENT THAT SUCH CONSUMER GUARANTEES CONTINUE TO APPLY, THEN TO THE FULL EXTENT PERMITTED BY THE APPLICABLE LEGISLATION, THE LIABILITY OF CSIRO UNDER THE RELEVANT CONSUMER GUARANTEE IS LIMITED (WHERE PERMITTED AT CSIRO'S OPTION) TO ONE OF FOLLOWING REMEDIES OR SUBSTANTIALLY EQUIVALENT REMEDIES: (a) THE REPLACEMENT OF THE SOFTWARE, THE SUPPLY OF EQUIVALENT SOFTWARE, OR SUPPLYING RELEVANT SERVICES AGAIN; (b) THE REPAIR OF THE SOFTWARE; (c) THE PAYMENT OF THE COST OF REPLACING THE SOFTWARE, OF ACQUIRING EQUIVALENT SOFTWARE, HAVING THE RELEVANT SERVICES SUPPLIED AGAIN, OR HAVING THE SOFTWARE REPAIRED. IN THIS CLAUSE, CSIRO INCLUDES ANY THIRD PARTY AUTHOR OR OWNER OF ANY PART OF THE SOFTWARE OR MATERIAL DISTRIBUTED WITH IT. CSIRO MAY ENFORCE ANY RIGHTS ON BEHALF OF THE RELEVANT THIRD PARTY. |
| keywords |
geochemistry
compositional data
visualisation
petrology
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `pyrolite`
<img src="https://raw.githubusercontent.com/morganjwilliams/pyrolite/develop/docs/source/_static/icon.jpg" alt="pyrolite Logo" width="30%" align="right">
[](https://pyrolite.readthedocs.io/)
[](https://github.com/pyOpenSci/software-review/issues/20)
[](https://doi.org/10.21105/joss.02314)
[](https://github.com/morganjwilliams/pyrolite/blob/main/LICENSE)
[](https://mybinder.org/v2/gh/morganjwilliams/pyrolite/develop?labpath=docs%2Fnotebooks%2F)
[](https://gitter.im/pyrolite/community/)
pyrolite is a set of tools for making the most of your geochemical data.
The python package includes functions to work with compositional data, to transform
geochemical variables (e.g. elements to oxides), functions for common plotting
tasks (e.g. spiderplots, ternary diagrams, bivariate and ternary density diagrams),
and numerous auxiliary utilities.
pyrolite is principally developed for use in geochemical research, but is also
well suited to being incorporated into university-level geochemistry and petrology
classes which wish to include a little Python. The documentation is continually
evolving, and more examples and tutorials will gradually be added (feel free to
request features or examples; see [Contributing](#contributing) below).
## Install
[](https://pypi.python.org/pypi/pyrolite)
[](https://pypi.python.org/pypi/pyrolite/)
[](https://pypistats.org/packages/pyrolite)
```bash
pip install pyrolite
```
If you want the most up to date *development* version, you can instead install directly from the GitHub repo. Note that breaking changes occur on this branch, and is not guaranteed to remain stable (check the [Development and Build Status](#development--build-status) below). If you still want to try out the most recent bugfixes and yet-to-be-released features, you can install this version with:
```bash
pip install git+git://github.com/morganjwilliams/pyrolite.git@develop#egg=pyrolite
```
For more information, see the documentation's [installation page](https://pyrolite.readthedocs.io/en/main/installation.html), and the [Getting Started Guide](https://pyrolite.readthedocs.io/en/main/gettingstarted.html).
## Examples
Check out the documentation for galleries of [examples](https://pyrolite.readthedocs.io/en/main/examples/index.html) and [tutorials](https://pyrolite.readthedocs.io/en/main/tutorials/index.html).
The corresponding sources of these examples exist as marked-up `.py` files in this repository (which get converted to Jupyter notebooks on ReadTheDocs); you can find them under the folders [`docs/source/gallery/examples`](./docs/source/gallery/examples/) and [`docs/source/gallery/tutorials`](./docs/source/gallery/tutorials/).
## Contributing
The long-term aim of this project is to be designed, built and supported by (and for) the geochemistry community. The project welcomes feature requests, bug reports and contributions to the code base, documentation and test suite. We're happy to help onboard new contributors and walk you through the process. Check out the [Issues Board](https://github.com/morganjwilliams/pyrolite/issues) to get an idea of some of the some of the currently identified bugs and things we're looking to work on. For more information, see the [documentation](https://pyrolite.readthedocs.io/), particularly the [
Contributing page](https://pyrolite.readthedocs.io/en/main/dev/contributing.html) and [Code of Conduct](https://pyrolite.readthedocs.io/en/main/dev/conduct.html).
For a list of people who have helped build and improve pyrolite, check out the [Contributors page](https://pyrolite.readthedocs.io/en/main/dev/contributors.html).
If you'd like an idea of where the project might be heading in the near future, have a look at [the current roadmap](https://pyrolite.readthedocs.io/en/main/dev/future.html).
## Citation
[](https://doi.org/10.21105/joss.02314)
[](https://zenodo.org/badge/latestdoi/137172322)
If you use pyrolite extensively for your research, citation of the software would be particularly appreciated. It helps quantify the impact of the project (assisting those contributing through paid and volunteer work), and is one way to get the message out and help build the pyrolite community. For information on citing pyrolite, [see the relevant docs page](https://pyrolite.readthedocs.io/en/main/cite.html).
## Development & Build Status
[](https://github.com/python/black)
[](https://app.codacy.com/gh/morganjwilliams/pyrolite/dashboard?utm_source=github.com&utm_medium=referral&utm_content=morganjwilliams/pyrolite&utm_campaign=Badge_Grade)
| **main** | **develop** |
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [](https://github.com/morganjwilliams/pyrolite/actions?query=workflow:Unittest+branch:main) | [](https://github.com/morganjwilliams/pyrolite/actions?query=workflow:Unittest+branch:develop) |
| [](https://coveralls.io/github/morganjwilliams/pyrolite?branch=main) | [](https://coveralls.io/github/morganjwilliams/pyrolite?branch=develop) |
**Maintainer**: Morgan Williams (morgan.williams _at_ csiro.au)
Raw data
{
"_id": null,
"home_page": "",
"name": "pyrolite",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "geochemistry,compositional data,visualisation,petrology",
"author": "",
"author_email": "Morgan Williams <morgan.williams@csiro.au>",
"download_url": "https://files.pythonhosted.org/packages/df/79/7202df5e3df8ed01bae2a3174001cb7401ca493ea0698b1f1d38387f560c/pyrolite-0.3.5.post0.tar.gz",
"platform": null,
"description": "# `pyrolite`\r\n\r\n<img src=\"https://raw.githubusercontent.com/morganjwilliams/pyrolite/develop/docs/source/_static/icon.jpg\" alt=\"pyrolite Logo\" width=\"30%\" align=\"right\">\r\n\r\n[](https://pyrolite.readthedocs.io/)\r\n[](https://github.com/pyOpenSci/software-review/issues/20)\r\n[](https://doi.org/10.21105/joss.02314)\r\n[](https://github.com/morganjwilliams/pyrolite/blob/main/LICENSE)\r\n[](https://mybinder.org/v2/gh/morganjwilliams/pyrolite/develop?labpath=docs%2Fnotebooks%2F)\r\n[](https://gitter.im/pyrolite/community/)\r\n\r\n\r\npyrolite is a set of tools for making the most of your geochemical data.\r\n\r\nThe python package includes functions to work with compositional data, to transform\r\ngeochemical variables (e.g. elements to oxides), functions for common plotting\r\ntasks (e.g. spiderplots, ternary diagrams, bivariate and ternary density diagrams),\r\nand numerous auxiliary utilities.\r\n\r\npyrolite is principally developed for use in geochemical research, but is also\r\nwell suited to being incorporated into university-level geochemistry and petrology\r\nclasses which wish to include a little Python. The documentation is continually\r\nevolving, and more examples and tutorials will gradually be added (feel free to\r\nrequest features or examples; see [Contributing](#contributing) below).\r\n\r\n## Install\r\n\r\n[](https://pypi.python.org/pypi/pyrolite)\r\n[](https://pypi.python.org/pypi/pyrolite/)\r\n[](https://pypistats.org/packages/pyrolite)\r\n\r\n```bash\r\npip install pyrolite\r\n```\r\n\r\nIf you want the most up to date *development* version, you can instead install directly from the GitHub repo. Note that breaking changes occur on this branch, and is not guaranteed to remain stable (check the [Development and Build Status](#development--build-status) below). If you still want to try out the most recent bugfixes and yet-to-be-released features, you can install this version with:\r\n\r\n```bash\r\npip install git+git://github.com/morganjwilliams/pyrolite.git@develop#egg=pyrolite\r\n```\r\n\r\nFor more information, see the documentation's [installation page](https://pyrolite.readthedocs.io/en/main/installation.html), and the [Getting Started Guide](https://pyrolite.readthedocs.io/en/main/gettingstarted.html).\r\n\r\n## Examples\r\n\r\nCheck out the documentation for galleries of [examples](https://pyrolite.readthedocs.io/en/main/examples/index.html) and [tutorials](https://pyrolite.readthedocs.io/en/main/tutorials/index.html).\r\nThe corresponding sources of these examples exist as marked-up `.py` files in this repository (which get converted to Jupyter notebooks on ReadTheDocs); you can find them under the folders [`docs/source/gallery/examples`](./docs/source/gallery/examples/) and [`docs/source/gallery/tutorials`](./docs/source/gallery/tutorials/).\r\n\r\n## Contributing\r\n\r\nThe long-term aim of this project is to be designed, built and supported by (and for) the geochemistry community. The project welcomes feature requests, bug reports and contributions to the code base, documentation and test suite. We're happy to help onboard new contributors and walk you through the process. Check out the [Issues Board](https://github.com/morganjwilliams/pyrolite/issues) to get an idea of some of the some of the currently identified bugs and things we're looking to work on. For more information, see the [documentation](https://pyrolite.readthedocs.io/), particularly the [\r\nContributing page](https://pyrolite.readthedocs.io/en/main/dev/contributing.html) and [Code of Conduct](https://pyrolite.readthedocs.io/en/main/dev/conduct.html).\r\n\r\nFor a list of people who have helped build and improve pyrolite, check out the [Contributors page](https://pyrolite.readthedocs.io/en/main/dev/contributors.html).\r\n\r\nIf you'd like an idea of where the project might be heading in the near future, have a look at [the current roadmap](https://pyrolite.readthedocs.io/en/main/dev/future.html).\r\n\r\n## Citation\r\n[](https://doi.org/10.21105/joss.02314)\r\n[](https://zenodo.org/badge/latestdoi/137172322)\r\n\r\nIf you use pyrolite extensively for your research, citation of the software would be particularly appreciated. It helps quantify the impact of the project (assisting those contributing through paid and volunteer work), and is one way to get the message out and help build the pyrolite community. For information on citing pyrolite, [see the relevant docs page](https://pyrolite.readthedocs.io/en/main/cite.html).\r\n\r\n## Development & Build Status\r\n\r\n[](https://github.com/python/black)\r\n[](https://app.codacy.com/gh/morganjwilliams/pyrolite/dashboard?utm_source=github.com&utm_medium=referral&utm_content=morganjwilliams/pyrolite&utm_campaign=Badge_Grade)\r\n\r\n| **main** | **develop** |\r\n|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|\r\n| [](https://github.com/morganjwilliams/pyrolite/actions?query=workflow:Unittest+branch:main) | [](https://github.com/morganjwilliams/pyrolite/actions?query=workflow:Unittest+branch:develop) |\r\n| [](https://coveralls.io/github/morganjwilliams/pyrolite?branch=main) | [](https://coveralls.io/github/morganjwilliams/pyrolite?branch=develop) |\r\n\r\n**Maintainer**: Morgan Williams (morgan.williams _at_ csiro.au)\r\n",
"bugtrack_url": null,
"license": "CSIRO Open Source Software Licence Agreement (Variation of the BSD/MIT License) Copyright (C) 2018 CSIRO Commonwealth Scientific and Industrial Research Organisation ABN 41 687 119 230. All rights reserved. CSIRO is willing to grant you a licence to pyrolite on the following terms, except where otherwise indicated for third party material. Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of CSIRO nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of CSIRO. As a condition of this licence, you agree that where you make any adaptations, modifications, further developments, or additional features available to CSIRO or the public in connection with your access to the Software, you do so on the terms of the BSD 3-Clause Licence template. A copy can be found at: http://opensource.org/licenses/BSD-3-Clause EXCEPT AS EXPRESSLY STATED IN THIS AGREEMENT AND TO THE FULL EXTENT PERMITTED BY APPLICABLE LAW, THE SOFTWARE IS PROVIDED \"AS-IS\". CSIRO MAKES NO REPRESENTATIONS, WARRANTIES OR CONDITIONS OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY REPRESENTATIONS, WARRANTIES OR CONDITIONS REGARDING THE CONTENTS OR ACCURACY OF THE SOFTWARE, OR OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, THE ABSENCE OF LATENT OR OTHER DEFECTS, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. TO THE FULL EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL CSIRO BE LIABLE ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, IN AN ACTION FOR BREACH OF CONTRACT, NEGLIGENCE OR OTHERWISE) FOR ANY CLAIM, LOSS, DAMAGES OR OTHER LIABILITY HOWSOEVER INCURRED. WITHOUT LIMITING THE SCOPE OF THE PREVIOUS SENTENCE THE EXCLUSION OF LIABILITY SHALL INCLUDE: LOSS OF PRODUCTION OR OPERATION TIME, LOSS, DAMAGE OR CORRUPTION OF DATA OR RECORDS; OR LOSS OF ANTICIPATED SAVINGS, OPPORTUNITY, REVENUE, PROFIT OR GOODWILL, OR OTHER ECONOMIC LOSS; OR ANY SPECIAL, INCIDENTAL, INDIRECT, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES, ARISING OUT OF OR IN CONNECTION WITH THIS AGREEMENT, ACCESS OF THE SOFTWARE OR ANY OTHER DEALINGS WITH THE SOFTWARE, EVEN IF CSIRO HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH CLAIM, LOSS, DAMAGES OR OTHER LIABILITY. APPLICABLE LEGISLATION SUCH AS THE AUSTRALIAN CONSUMER LAW MAY APPLY REPRESENTATIONS, WARRANTIES, OR CONDITIONS, OR IMPOSE OBLIGATIONS OR LIABILITY ON CSIRO THAT CANNOT BE EXCLUDED, RESTRICTED OR MODIFIED TO THE FULL EXTENT SET OUT IN THE EXPRESS TERMS OF THIS CLAUSE ABOVE \"CONSUMER GUARANTEES\". TO THE EXTENT THAT SUCH CONSUMER GUARANTEES CONTINUE TO APPLY, THEN TO THE FULL EXTENT PERMITTED BY THE APPLICABLE LEGISLATION, THE LIABILITY OF CSIRO UNDER THE RELEVANT CONSUMER GUARANTEE IS LIMITED (WHERE PERMITTED AT CSIRO'S OPTION) TO ONE OF FOLLOWING REMEDIES OR SUBSTANTIALLY EQUIVALENT REMEDIES: (a) THE REPLACEMENT OF THE SOFTWARE, THE SUPPLY OF EQUIVALENT SOFTWARE, OR SUPPLYING RELEVANT SERVICES AGAIN; (b) THE REPAIR OF THE SOFTWARE; (c) THE PAYMENT OF THE COST OF REPLACING THE SOFTWARE, OF ACQUIRING EQUIVALENT SOFTWARE, HAVING THE RELEVANT SERVICES SUPPLIED AGAIN, OR HAVING THE SOFTWARE REPAIRED. IN THIS CLAUSE, CSIRO INCLUDES ANY THIRD PARTY AUTHOR OR OWNER OF ANY PART OF THE SOFTWARE OR MATERIAL DISTRIBUTED WITH IT. CSIRO MAY ENFORCE ANY RIGHTS ON BEHALF OF THE RELEVANT THIRD PARTY. ",
"summary": "Tools for geochemical data analysis.",
"version": "0.3.5.post0",
"project_urls": {
"Code": "https://github.com/morganjwilliams/pyrolite",
"Documentation": "https://pyrolite.readthedocs.io/",
"Issue tracker": "https://github.com/morganjwilliams/pyrolite/issues"
},
"split_keywords": [
"geochemistry",
"compositional data",
"visualisation",
"petrology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39bc17ee3c6aacea3082b56f238d987b8037aef04ac6bbeefd878a1316f0b771",
"md5": "3d992bb6f5ccf6ccd000cfb9e00c8490",
"sha256": "6a64af71a45d0bd747037b1ed7baddc1b796ff28a55cde8af1606e51cfaf7de3"
},
"downloads": -1,
"filename": "pyrolite-0.3.5.post0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d992bb6f5ccf6ccd000cfb9e00c8490",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 880147,
"upload_time": "2024-02-26T05:55:32",
"upload_time_iso_8601": "2024-02-26T05:55:32.887986Z",
"url": "https://files.pythonhosted.org/packages/39/bc/17ee3c6aacea3082b56f238d987b8037aef04ac6bbeefd878a1316f0b771/pyrolite-0.3.5.post0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df797202df5e3df8ed01bae2a3174001cb7401ca493ea0698b1f1d38387f560c",
"md5": "bbe6fd704a98c49957408f5b739bf5b4",
"sha256": "bd6cdc436aac1c5e5b3a4e95ea47acdbefca4fccc57407ff75492a422d5442c6"
},
"downloads": -1,
"filename": "pyrolite-0.3.5.post0.tar.gz",
"has_sig": false,
"md5_digest": "bbe6fd704a98c49957408f5b739bf5b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 397304,
"upload_time": "2024-02-26T05:55:36",
"upload_time_iso_8601": "2024-02-26T05:55:36.584700Z",
"url": "https://files.pythonhosted.org/packages/df/79/7202df5e3df8ed01bae2a3174001cb7401ca493ea0698b1f1d38387f560c/pyrolite-0.3.5.post0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 05:55:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "morganjwilliams",
"github_project": "pyrolite",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyrolite"
}
