neptoon 0.1.0__tar.gz

neptoon-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Martin Schrön and Daniel Power
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

neptoon-0.1.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.1
+Name: neptoon
+Version: 0.1.0
+Summary: The neptoon package makes CRNS processing and research simple.
+Home-page: https://codebase.helmholtz.cloud/cosmos/neptoon
+License: MIT
+Author: Daniel Power
+Author-email: daniel.power@ufz.de
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
+Requires-Dist: flake8 (>=7.0.0,<8.0.0)
+Requires-Dist: pandas (>=2.2.0,<3.0.0)
+Requires-Dist: pandera (>=0.18.0,<0.19.0)
+Requires-Dist: platformdirs (>=4.2.0,<5.0.0)
+Requires-Dist: pyaml (>=23.12.0,<24.0.0)
+Requires-Dist: pyarrow (>=15.0.0,<16.0.0)
+Requires-Dist: pydantic (>=2.6.1,<3.0.0)
+Requires-Dist: pytest (>=8.0.0,<9.0.0)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: saqc (>=2.6.0,<3.0.0)
+Requires-Dist: urllib3 (>=2.2.0,<3.0.0)
+Project-URL: Documentation, https://neptoon-docs.readthedocs.io/en/latest/
+Project-URL: Repository, https://codebase.helmholtz.cloud/cosmos/neptoon
+Description-Content-Type: text/markdown
+
+
+## Name
+
+neptoon
+
+## **What is neptoon?**
+
+neptoon is a python tool for processing Cosmic-Ray Neutron Sensors (CRNS). CRNS estimate soil moisture at the field scale, and up to root-zone depths, by tracking changes in the number of fast neutrons found at a particular location. This is primarily due to the strong inverse relationship quantities of hydrogen atoms and fast neutrons. To have estimates of only the impact of hydrogen in soil moisture, additional processing and correction steps are required. Our understanding of the sensor continues to grow and change, which brings about an increasing number of theories and equations that can be applied. 
+
+Neptoon is designed to facilitate the painless processing of CRNS sites, utilising the most current techniques and knowledge available. It is designed to be simple to use for those who wish to simply correct a sensor with the most current understanding, as well as full featured for researchers in the CRNS space who want to experiment and test new ideas. 
+
+
+## Badges
+
+WIP
+
+## Visuals
+
+WIP
+
+## Installation
+
+Installation of neptoon will be via pip using:
+
+`pip install neptoon`
+
+## Usage
+
+WIP
+
+## Support
+
+daniel.power@ufz.de
+martin.schroen@ufz.de
+
+## Roadmap
+
+WIP
+
+## Contributing
+
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+
+Martin Schrön, Daniel Power
+
+## License
+
+MIT License
+
+## Project status
+
+Ongoing project currently being supported by Helmholtz Zentrum for
+Research and University of Bristo
+

neptoon-0.1.0/README.md

@@ -0,0 +1,59 @@
+
+## Name
+
+neptoon
+
+## **What is neptoon?**
+
+neptoon is a python tool for processing Cosmic-Ray Neutron Sensors (CRNS). CRNS estimate soil moisture at the field scale, and up to root-zone depths, by tracking changes in the number of fast neutrons found at a particular location. This is primarily due to the strong inverse relationship quantities of hydrogen atoms and fast neutrons. To have estimates of only the impact of hydrogen in soil moisture, additional processing and correction steps are required. Our understanding of the sensor continues to grow and change, which brings about an increasing number of theories and equations that can be applied. 
+
+Neptoon is designed to facilitate the painless processing of CRNS sites, utilising the most current techniques and knowledge available. It is designed to be simple to use for those who wish to simply correct a sensor with the most current understanding, as well as full featured for researchers in the CRNS space who want to experiment and test new ideas. 
+
+
+## Badges
+
+WIP
+
+## Visuals
+
+WIP
+
+## Installation
+
+Installation of neptoon will be via pip using:
+
+`pip install neptoon`
+
+## Usage
+
+WIP
+
+## Support
+
+daniel.power@ufz.de
+martin.schroen@ufz.de
+
+## Roadmap
+
+WIP
+
+## Contributing
+
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+
+Martin Schrön, Daniel Power
+
+## License
+
+MIT License
+
+## Project status
+
+Ongoing project currently being supported by Helmholtz Zentrum for
+Research and University of Bristo