Skip to main content

The VIPER Science package is software to support the activities of the Volatiles Investigating Polar Exploration Rover (VIPER) Science Team.

Project description

vipersci

https://github.com/NeoGeographyToolkit/vipersci/actions/workflows/python-test.yml/badge.svg https://codecov.io/github/NeoGeographyToolkit/vipersci/branch/main/graph/badge.svg?token=5U68VOAHGG https://img.shields.io/pypi/v/vipersci.svg

This vipersci package is software to support the activities of the Volatiles Investigating Polar Exploration Rover (VIPER) Science Team.

This software will implement scientific models to convert instrument raw data to useful derived data (but not including any proprietary instrument details). This includes functionality for running the models “in reverse” in order to simulate instrument data for tests and mission simulations. This software will enable and support the creation of various geospatial data sets (maps) to help visualize and understand data from the spacecraft. It will also support the creation of PDS4 archive labels and structures for eventual data delivery to the Planetary Data System (PDS).

At the moment, this repo is under significant development and change as we attempt to craft various pieces of code. It is definitely a work-in-progress.

The VIPER Science Team is developing this software “in the open” in order to adhere to the new NASA Science Information Policy for the Science Mission Directorate (SPD-41) as much as is possible.

  • Free software: Apache 2 License

Installation

Versions will be posted to PyPI and conda to ease installation soon.

For the moment, follow the “Get Started!” directions in the CONTRIBUTING.rst document.

Contributing

Feedback, issues, and contributions are always gratefully welcomed. See the contributing guide for details on how to help and setup a development environment.

Credits

vipersci was developed in the open at NASA’s Ames Research Center.

See the AUTHORS file for a complete list of developers.

License

See LICENSE file for the full text of the license that applies to vipersci.

Copyright (c) 2022, United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All rights reserved.

The “vipersci” software is licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

When updating this file, please add an entry for your change under Unreleased and one of the following headings:

  • Added - for new features.

  • Changed - for changes in existing functionality.

  • Deprecated - for soon-to-be removed features.

  • Removed - for now removed features.

  • Fixed - for any bug fixes.

  • Security - in case of vulnerabilities.

If the heading does not yet exist under Unreleased, then add it as a 3rd level heading, underlined with pluses (see examples below).

When preparing for a public release add a new 2nd level heading, underlined with dashes under Unreleased with the version number and the release date, in year-month-day format (see examples below).

Unreleased

0.3.0 (2022-11-15)

Added

  • pds.datetime.fromisozformat() function.

  • pds.pid.VISID.compression_class() function.

  • pds.xml.py added, very minimal, functionality may be moved.

  • vis.db.raw_products.RawProduct.from_xml() function.

  • vis.db.raw_products.RawProduct.asdict() function.

  • vis.pds.create_raw.check_bit_depth() function.

  • vis.db.create_vis_dbs convenience program to add empty tables to database.

Changed

  • Updated templates and modules for PDS information model 18.

  • vis.db.raw_products.RawProduct has some improved error-checking in __init__() and validate_datetime_asutc().

  • vis.db.raw_products.RawProduct product_id column is now unique in database.

  • vis.db.raw_products.RawProduct md5_checksum changed to file_md4_checksum to clearly associate it with the other properties that begin with “file_”.

  • vis.pds.create_raw.tiff_info() no longer raises an error if a bit depth other than 16 is provided.

  • vis.pds.create_raw now creates .JSON output files by default instead of XML PDS4 labels, but XML files can still be made.

  • carto.heatmap.write_geotiff_rasterio now supports compressed output and defaults to “deflate”

Fixed

  • carto.tri2gpkg.replace_with() now correctly returns a float value in all circumstances.

  • pds.pid.VIPERID.datetime() now properly returns datetimes with a UTC timezone.

  • vis.db.raw_products.RawProduct.label_dict() now correctly sets sample_bits and sample_bit_mask if the image is a SLoG image.

  • Added __init__.py files to all modules (some modules did not get incorporated into the PyPI package because they did not have __init__.py files.

  • The setup.cfg now properly includes requirements that vipersci needs.

Removed

  • Many modules still had if __name__ == “__main__” constructs from early development which are now not needed with the entry points in setup.cfg.

0.2.0 (2022-11-07)

Added

  • Data Simulators for NSS, NIRVSS, and MSolo

  • Lots of material to enaable PDS archiving of VIS data.

  • Added GitHub workflow to perform Black format checking

Changed

  • Many updates to heatmap.py

  • Applied Black formatting to all code in the repo.

  • Modified Python testing workflow to actually work.

0.1.0 (2022-10-05)

Initial release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vipersci-0.3.0.tar.gz (62.5 kB view hashes)

Uploaded Source

Built Distribution

vipersci-0.3.0-py2.py3-none-any.whl (66.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page