Atmospheric Community Toolkit (ACT)

The Atmospheric data Community Toolkit (ACT) is an open source Python toolkit for working with atmospheric time-series datasets of varying dimensions. The toolkit is meant to have functions for every part of the scientific process; discovery, IO, quality control, corrections, retrievals, visualization, and analysis. It is meant to be 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 .

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

Dependencies

xarray

NumPy

SciPy

matplotlib

skyfield

pandas

dask

Pint

PyProj

Proj

Six

Requests

MetPy

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

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. 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.