pyIntensityFeatures 0.1.0__tar.gz

pyintensityfeatures-0.1.0/.readthedocs.yml

@@ -0,0 +1,24 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Declare the Python requirements required to build your docs
+# This method includes a local build of the package
+python:
+   install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

pyintensityfeatures-0.1.0/.zenodo.json

@@ -0,0 +1,35 @@
+{
+    "license": {
+      "id": "bsd-license"
+    },
+    "keywords": [
+  "aurora",
+  "aurora australis",
+  "aurora borealis",
+  "boundaries",
+  "imager",
+  "ionosphere",
+  "heliophysics",
+  "magnetosphere",
+  "northern lights",
+  "intensity",
+  "southern lights",
+  "features"
+    ],
+    "creators": [
+      {
+        "orcid": "0000-0001-8875-9326", 
+        "affiliation": "Naval Research Laboratory", 
+        "name": "Angeline G. Burrell"
+      },
+      {
+        "affiliation": "KPMG", 
+        "name": "Nicola S. Longden"
+      },
+      {
+        "orcid": "0000-0003-1151-5934", 
+        "affiliation": "British Antarctic Survey", 
+        "name": "Gareth Chisham"
+      }
+    ]
+}

pyintensityfeatures-0.1.0/ACKNOWLEDGEMENTS.rst

@@ -0,0 +1,4 @@
+Acknowledgements
+================
+
+A.G.B was supported by the Office of Naval Research (ONR).

pyintensityfeatures-0.1.0/CHANGELOG.md

@@ -0,0 +1,17 @@
+Changelog
+=========
+
+Summary of all changes made since the first release
+
+0.1.0 (2025-03-28)
+------------------
+* Added option to specify maximum dayglow
+* Updated `as_datetime` to remove timezone information
+* Added a unique function that rounds to a specified significance level
+* Extracted code that identified the parameters for Gaussian fitting into a
+  separate function
+* Added publication release statements
+
+0.0.1 (2024-03-01)
+------------------
+* Alpha Release

pyintensityfeatures-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age,
+body size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an
+appointed representative at an online or offline event. Representation of a
+project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at angeline.g.burrell.civ@us.navy.mil.
+The project team will review and investigate all complaints, and will respond
+in a way that it deems appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

pyintensityfeatures-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,177 @@
+Contributing
+============
+
+Bug reports, feature suggestions, and other contributions are greatly
+appreciated!  pyIntensityFeatures is a community-driven project and welcomes
+both feedback and contributions.
+
+Short version
+-------------
+
+* Submit bug reports, feature requests, and questions at
+  [GitHub](https://github.com/aburrell/pyIntensityFeatures/issues)
+
+* Make pull requests to the ``develop`` branch
+
+Issues
+------
+
+Bug reports, questions, and feature requests should all be made as GitHub
+Issues.  Templates are provided for each type of issue, to help you include
+all the necessary information.
+
+Questions
+^^^^^^^^^
+
+Not sure how something works?  Ask away!  The more information you provide, the
+easier the question will be to answer.  You can also search the closed issues
+for potential answers to your questions.
+
+Bug reports
+^^^^^^^^^^^
+
+When [reporting a bug](https://github.com/aburrell/pyIntensityFeatures/issues)
+please include:
+
+* Your operating system name and version
+
+* Any details about your local setup that might be helpful in troubleshooting
+
+* Detailed steps to reproduce the bug
+
+Feature requests and feedback
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The best way to send feedback is to file an
+[issue](https://github.com/aburrell/pyIntensityFeatures/issues).
+
+If you are proposing a new feature or a change in something that already exists:
+
+* Explain in detail how it would work.
+
+* Keep the scope as narrow as possible, to make it easier to implement.
+
+* Remember that this is a volunteer-driven project, and that code contributions
+  are welcome :)
+
+Development
+-----------
+
+To set up `pyIntensityFeatures` for local development:
+
+1. [Fork pyIntensityFeatures on
+    GitHub](https://github.com/aburrell/pyIntensityFeatures/fork).
+
+2. Clone your fork locally:
+
+  ```
+    git clone git@github.com:your_name_here/pyIntensityFeatures.git
+  ```
+
+3. Create a branch for local development:
+
+  `git checkout -b name-of-your-bugfix-or-feature`
+
+   Now you can make your changes locally.
+
+   Tests for custom functions should be added to the appropriately named file
+   in ``pyIntensityFeatures/tests``. For example, custom functions for the grid
+   utilities are tested in ``pyIntensityFeatures/tests/test_utils_grids.py``.
+   If no test file exists, then you should create one.  This testing uses
+   unittest, which will run tests on any Python file in the test directory that
+   starts with ``test``.  Classes must begin with ``Test``, and methods must
+   begin with ``test`` as well.
+
+4. When you're done making changes, run all the checks to ensure that nothing
+   is broken on your local system, as well as check for flake8 compliance:
+
+   ```
+    python -m unittest discover
+   ```
+
+5. You should also check for flake8 style compliance:
+
+   ```
+   flake8 . --count --select=D,E,F,H,W --show-source --statistics
+   ```
+
+   Note that pyIntensityFeatures tests for uniformity in docstring formatting.
+
+6. Update/add documentation (in ``docs``).  Even if you don't think it's
+   relevant, check to see if any existing examples have changed.
+
+7. Add your name, affiliation, and ORCiD to the .zenodo.json file as an author
+
+8. Commit your changes:
+   ```
+   git add .
+   git commit -m "AAA: Brief description of your changes"
+   ```
+   Where AAA is a standard shorthand for the type of change (e.g., BUG or DOC).
+   `pyIntensityFeatures` follows the [numpy development workflow](https://numpy.org/doc/stable/dev/development_workflow.html),
+   see the discussion there for a full list of this shorthand notation.
+
+9. Once you are happy with the local changes, push to GitHub:
+   ```
+   git push origin name-of-your-bugfix-or-feature
+   ```
+   Note that each push will trigger the Continuous Integration workflow.
+
+10. Submit a pull request through the GitHub website. Pull requests should be
+    made to the ``develop`` branch.  Note that automated tests will be run on
+    GitHub Actions, but these must be initialized by a member of the
+    pyIntensityFeatures team for first time contributors.
+
+
+Pull Request Guidelines
+-----------------------
+
+If you need some code review or feedback while you're developing the code, just
+make a pull request. Pull requests should be made to the ``develop`` branch.
+
+For merging, you should:
+
+1. Include an example for use
+2. Add a note to ``CHANGELOG.md`` about the changes
+3. Update the author list in ``zenodo.json``, if applicable
+4. Ensure that all checks passed (future checks will include GitHub Actions,
+   Coveralls and ReadTheDocs)
+
+If you don't have all the necessary Python versions available locally or have
+trouble building all the testing environments, you can rely on GitHub Actions to
+run the tests for each change you add in the pull request. Because testing here
+will delay tests by other developers, please ensure that the code passes all
+tests on your local system first.
+
+
+Project Style Guidelines
+------------------------
+
+In general, pyIntensityFeatures follows PEP8 and numpydoc guidelines. unittest
+runs the unit and integration tests, flake8 checks for style, and sphinx-build
+performs documentation tests.  However, there are certain additional style
+elements that have been adopted to ensure the project maintains a consistent
+coding style. These include:
+
+* Line breaks should occur before a binary operator (ignoring flake8 W503)
+* Combine long strings using `join`
+* Preferably break long lines on open parentheses rather than using `\`
+* Use no more than 80 characters per line
+* The pyIntensityFeatures logger is imported into each sub-module and provides
+  status updates at the info and warning levels (as appropriate)
+* Several dependent packages have common nicknames, including:
+  * `import datetime as dt`
+  * `import numpy as np`
+  * `import pandas as pds`
+  * `import xarray as xr`
+* When incrementing a timestamp, use `dt.timedelta` instead of `pds.DateOffset`
+  when possible to reduce program runtime
+* All classes should have `__repr__` and `__str__` functions
+* Avoid creating a try/except statement where except passes
+* Provide testing class methods with informative failure statements and
+  descriptive, one-line docstrings
+* Block and inline comments should use proper English grammar and punctuation
+  with the exception of single sentences in a block, which may then omit the
+  final period. Both British and American spelling is permitted.
+* When casting is necessary, use `np.int64` and `np.float64` to ensure operating
+  system agnosticism

pyintensityfeatures-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2025, Angeline G. Burrell (AGB), Gareth Chisham (GC), and
+Nicola Longden (NL)
+All rights reserved.
+
+Redistribution and use 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 ocbpy nor the names of its contributors may be used to
+  endorse or promote products derived from this software without specific
+  prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pyintensityfeatures-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include *.rst
+include *.md
+include LICENSE
+
+include *.cfg
+include *.toml
+include *.yml
+include .zenodo.json