Skip to main content

Package for working with atmospheric time series datasets

Project description

AnacondaCloud CodeCovStatus Build Docs

CondaDownloads PyPiDownloads Zenodo ARM

The Atmospheric data Community Toolkit (ACT) is an open source Python toolkit for working with atmospheric time-series datasets of varying dimensions. The toolkit has functions for every part of the scientific process; discovery, IO, quality control, corrections, retrievals, visualization, and analysis. It is a community platform for sharing code with the goal of reducing duplication of effort and better connecting the science community with programs such as the Atmospheric Radiation Measurement (ARM) User Facility. Overarching development goals will be updated on a regular basis as part of the Roadmap .

act

Please report any issues or feature requests by sumitting an Issue. Additionally, our discussions boards are open for ideas, general discussions or questions, and show and tell!

ACT’s Third Roadmap

To meet the needs of the community and stakeholders, ACT will be creating a new roadmap. This roadmap will continue a plan forward on features to improve on and to add in newer ACT versions. A part of this new roadmap is a survey from the community that will provide feedback for the developers on priorities for newer ACT versions. If time permitting, and you are a user of ACT or are considering to use ACT the survey can be found here: ACT Roadmap Survey The feedback would be much appreciated.

Citing

If you use ACT to prepare a publication, please cite the DOI listed in the badge above, which is updated with every version release to ensure that contributors get appropriate credit. DOI is provided through Zenodo.

Dependencies

Optional Dependencies

  • MPL2NC Reading binary MPL data.

  • Cartopy Mapping and geoplots

  • Py-ART Reading radar files, plotting and corrections

  • scikit-posthocs Using interquartile range or generalized Extreme Studentized Deviate quality control tests

  • icartt icartt is an ICARTT file format reader and writer for Python

  • PySP2 PySP2 is a python package for reading and processing Single Particle Soot Photometer (SP2) datasets.

  • MoviePy MoviePy is a python package for creating movies from images

Installation

ACT can be installed a few different ways. One way is to install using pip. When installing with pip, the ACT dependencies found in requirements.txt will also be installed. To install using pip:

pip install act-atmos

The easiest method for installing ACT is to use the conda packages from the latest release. To do this you must download and install Anaconda or Miniconda. With Anaconda or Miniconda install, it is recommended to create a new conda environment when using ACT or even other packages. To create a new environment based on the environment.yml:

conda env create -f environment.yml

Or for a basic environment and downloading optional dependencies as needed:

conda create -n act_env -c conda-forge python=3.12 act-atmos

Basic command in a terminal or command prompt to install the latest version of ACT:

conda install -c conda-forge act-atmos

To update an older version of ACT to the latest release use:

conda update -c conda-forge act-atmos

If you are using mamba:

mamba install -c conda-forge act-atmos

If you do not wish to use Anaconda or Miniconda as a Python environment or want to use the latest, unreleased version of ACT see the section below on Installing from source.

Installing from Source

Installing ACT from source is the only way to get the latest updates and enhancement to the software that have no yet made it into a release. The latest source code for ACT can be obtained from the GitHub repository, https://github.com/ARM-DOE/ACT. Either download and unpack the zip file of the source code or use git to checkout the repository:

git clone https://github.com/ARM-DOE/ACT.git

Once you have the directory locally, you can install ACT in development mode using:

pip install -e .

If you want to install the repository directly, you can use:

pip install git+https://github.com/ARM-DOE/ACT.git

Contributing

ACT is an open source, community software project. Contributions to the package are welcomed from all users.

The latest source code can be obtained with the command:

git clone https://github.com/ARM-DOE/ACT.git

If you are planning on making changes that you would like included in ACT, forking the repository is highly recommended.

We welcome contributions for all uses of ACT, provided the code can be distributed under the BSD 3-clause license. A copy of this license is available in the LICENSE.txt file in this directory. For more on contributing, see the contributor’s guide.

Testing

For testing, we use pytest for running the unit tests and arm-test-data for test files that are used for the unit tests. To install pytest:

$ conda install -c conda-forge pytest

And for matplotlib image testing with pytest:

$ conda install -c conda-forge pytest-mpl

To install arm-test-data:

$ conda install -c conda-forge arm-test-data

After installation of both pytest and arm-test-data, you can launch the test suite from outside the source directory (you will need to have pytest installed and for the mpl argument need pytest-mpl):

$ pytest --mpl --pyargs act

In-place installs can be tested using the pytest command from within the source directory.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

act_atmos-2.2.1.tar.gz (17.3 MB view details)

Uploaded Source

Built Distribution

act_atmos-2.2.1-py3-none-any.whl (6.5 MB view details)

Uploaded Python 3

File details

Details for the file act_atmos-2.2.1.tar.gz.

File metadata

  • Download URL: act_atmos-2.2.1.tar.gz
  • Upload date:
  • Size: 17.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for act_atmos-2.2.1.tar.gz
Algorithm Hash digest
SHA256 dd6ccced8474d710dc1b4fb3b2a5508ad34bd087d3afc32f95f5f4e468e180f6
MD5 bcdef8789a32b7d65d03632d65f119c2
BLAKE2b-256 f62b55f63bee5233bd07ef90e218311a23a90d0b9baa257912b3bd3f7911851d

See more details on using hashes here.

File details

Details for the file act_atmos-2.2.1-py3-none-any.whl.

File metadata

  • Download URL: act_atmos-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for act_atmos-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef216e58f75818b840f70b545a4d931d708453e7baf3655a69c0f8fe1ae661d2
MD5 e66206732d06f259139fdf5f1f397f2d
BLAKE2b-256 326e3c695ea3e984b9c6faade10dcc0383b876b9f4e82903beade89b2514c159

See more details on using hashes here.

Supported by

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