Package: act-atmos
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 theAtmospheric Radiation Measurement (ARM) User Facility.  Overarching development goals will be updated on a regular basis as part of theRoadmap.Please report any issues or feature requests by sumitting anIssue.  Additionally, ourdiscussions boardsare open for ideas, general discussions or questions, and show and tell!Version 2.0ACT now has a version 2.0 release. This release contains many function
naming changes such as IO and Discovery module function naming changes. To
prepare for this release, av2.0has been provided that explains the changes and how to work with the new syntax.The new release is available on both PyPI and conda-forge.Please report any bugs of the 2.0 release to the Issue Tracker mentioned in
the Important Links section below.Important LinksDocumentation:https://arm-doe.github.io/ACT/Examples:https://arm-doe.github.io/ACT/source/auto_examples/index.htmlIssue Tracker:https://github.com/ARM-DOE/ACT/issuesCitingIf 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.DependenciesxarrayNumPySciPymatplotlibskyfieldpandasdaskPintPyProjSixRequestsMetPyffspeclazy_loadercmweatherOptional DependenciesMPL2NCReading binary MPL data.CartopyMapping and geoplotsPy-ARTReading radar files, plotting and correctionsscikit-posthocsUsing interquartile range or generalized Extreme Studentized Deviate quality control testsicartticartt is an ICARTT file format reader and writer for PythonPySP2PySP2 is a python package for reading and processing Single Particle Soot Photometer (SP2) datasets.MoviePyMoviePy is a python package for creating movies from imagesInstallationACT can be installed a few different ways. One way is to install using pip.
When installing with pip, the ACT dependencies found inrequirements.txtwill also be installed. To install using pip:pip install act-atmosThe easiest method for installing ACT is to use the conda packages from
the latest release. To do this you must download and installAnacondaorMiniconda.
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 theenvironment.yml:conda env create -f environment.ymlOr for a basic environment and downloading optional dependencies as needed:conda create -n act_env -c conda-forge python=3.12 act-atmosBasic command in a terminal or command prompt to install the latest version of
ACT:conda install -c conda-forge act-atmosTo update an older version of ACT to the latest release use:conda update -c conda-forge act-atmosIf you are using mamba:mamba install -c conda-forge act-atmosIf 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 onInstalling from source.Installing from SourceInstalling 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 thezip fileof
the source code or use git to checkout the repository:git clone https://github.com/ARM-DOE/ACT.gitOnce 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.gitContributingACT 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.gitIf 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 theLICENSE.txtfile in this directory. For more on
contributing, see thecontributor’s guide.TestingFor testing, we use pytest. To install pytest:$ conda install -c conda-forge pytestAnd for matplotlib image testing with pytest:$ conda install -c conda-forge pytest-mplAfter installation, 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 actIn-place installs can be tested using thepytestcommand from within
the source directory.