Skip to content

Commit

Permalink
update to version 3.0 - Official
Browse files Browse the repository at this point in the history
  • Loading branch information
AStcherbinine committed Oct 23, 2023
1 parent 5db8157 commit 8fec424
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 15 deletions.
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ keywords:
- Physics
- Python 3
license: MIT
version: '2.3'
date-released: '2023-04-11'
version: '3.0'
date-released: '2023-10-23'
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 Aurélien Stcherbinine
Copyright (c) 2023 Aurélien Stcherbinine

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![version](https://img.shields.io/badge/version-3.0beta-blue)
![version](https://img.shields.io/badge/version-3.0-blue)
![pythonversion](https://img.shields.io/badge/Python-3.7+-blue)
[![DOI](https://zenodo.org/badge/349763849.svg)](https://zenodo.org/badge/latestdoi/349763849)

Expand All @@ -11,8 +11,6 @@

Importation and display of OMEGA/MEx observations in Python 3, based on the IDL *SOFT10* routines developped in the IAS planetary team.

> **Disclaimer:** This module is not the official software distributed by the OMEGA team.
## Installation & Update
### Method 1: from PyPI (recommended)
**Installation:** `pip3 install omegapy`
Expand Down
2 changes: 2 additions & 0 deletions docs/abbreviations.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@
*[MY]: Martian Year

*[DN]: Digital Numbers

*[PSA]: Planetary Science Archive
8 changes: 4 additions & 4 deletions docs/credits.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ This package is released under a MIT open source license. See [`LICENSE`](https:

## Citing OMEGA-Py
If you are using OMEGA-Py in your research, please cite it with:
Stcherbinine, Aurélien. (2023). OMEGA-Py: Python tools for OMEGA data (v2.4). *Zenodo*. [doi:10.5281/zenodo.8125436](https://doi.org/10.5281/zenodo.8125436)
Stcherbinine, Aurélien. (2023). OMEGA-Py: Python tools for OMEGA data (v3.0). *Zenodo*. [doi:10.5281/zenodo.8125436](https://doi.org/10.5281/zenodo.8125436)

BibTeX entry:
~~~bibtex
@software{omegapy_v2-4,
@software{omegapy_v3-0,
author = {Stcherbinine, Aurélien},
title = {OMEGA-Py: Python tools for OMEGA data},
month = jul,
month = oct,
year = 2023,
publisher = {Zenodo},
version = {v2.4},
version = {v3.0},
doi = {10.5281/zenodo.8125436},
url = {https://doi.org/10.5281/zenodo.8125436}
}
Expand Down
5 changes: 3 additions & 2 deletions docs/data_importation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
## Reading the binaries

Similarly to the `readomega.pro` IDL routine of the *SOFT 10*, OMEGA-Py read the binary
*.QUB* & *.NAV* files that can be downloaded from the ESA PSA to generate level 1B
Similarly to the `readomega.pro` IDL routine of the *SOFT 10*, OMEGA-Py read the level 1B binary
*.QUB* & *.NAV* files that can be downloaded from the ESA
[PSA](https://archives.esac.esa.int/psa/#!Table%20View/OMEGA=instrument) to generate level 2A
data with reflectance spectra.

!!! warning "Attention"
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@

<!--Importation and display of OMEGA/MEx observations in Python 3, based on the IDL *SOFT10* routines developped in the IAS planetary team.-->

!!! warning "Disclaimer"
This module is not the official software distributed by the OMEGA team.
<!--!!! warning "Disclaimer"-->
<!-- This module is not the official software distributed by the OMEGA team.-->

<!-- > **Disclaimer:** This module is not the official software distributed by the OMEGA team.-->

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

setuptools.setup(
name='omegapy',
version='3.0beta',
version='3.0',
author='Aurélien Stcherbinine',
author_email='[email protected]',
description='Python tools for OMEGA/MEx observations analysis',
Expand Down

0 comments on commit 8fec424

Please sign in to comment.