Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove arts module #386

Merged
merged 3 commits into from
Jun 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,8 @@ configuration is handled by the ``typhon.config`` module. The default file
location is ``~/.typhonrc`` but can be changed using the ``TYPHONRC``
environment variable.

It is also possible to set environment variables in the same-named
section of the configuration file, e.g.:
```
[environment]
ARTS_BUILD_PATH: /path/to/arts/build/
```

## Documentation
A daily build of the documentation is accessible
A recent build of the documentation is accessible
[online](http://radiativetransfer.org/misc/typhon/doc-trunk).
Kindly note that bleeding edge features might not be covered.

Expand Down
10 changes: 0 additions & 10 deletions doc/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,11 @@ Reference
ARTS
----

Data types and File I/O
```````````````````````
.. toctree::
:maxdepth: 1

typhon.arts

ARTS Interface
``````````````

.. toctree::
:maxdepth: 1

typhon.arts.workspace

Cloud mask
----------

Expand Down
150 changes: 4 additions & 146 deletions doc/typhon.arts.rst
Original file line number Diff line number Diff line change
@@ -1,149 +1,7 @@
arts
====

.. automodule:: typhon.arts

.. currentmodule:: typhon.arts

.. autosummary::
:toctree: generated

run_arts

arts.catalogues
===============

.. automodule:: typhon.arts.catalogues

.. currentmodule:: typhon.arts.catalogues

.. autosummary::
:toctree: generated

ArrayOfLineRecord
CIARecord
GasAbsLookup
LineMixingRecord
QuantumIdentifier
QuantumNumberRecord
QuantumNumbers
Sparse
SpeciesAuxData
SpeciesTag

arts.covariancematrix
=====================

.. automodule:: typhon.arts.covariancematrix

.. currentmodule:: typhon.arts.covariancematrix

.. autosummary::
:toctree: generated

Block
CovarianceMatrix
plot_covariance_matrix

arts.griddedfield
=================
.. automodule:: typhon.arts.griddedfield

.. currentmodule:: typhon.arts.griddedfield

.. autosummary::
:toctree: generated

GriddedField1
GriddedField2
GriddedField3
GriddedField4
GriddedField5
GriddedField6
griddedfield_from_netcdf
griddedfield_from_xarray

arts.internals
===============

.. automodule:: typhon.arts.internals

.. currentmodule:: typhon.arts.internals

.. autosummary::
:toctree: generated

LineMixing
ARTSCAT5
Rational
PartitionFunctions
PressureBroadening

arts.retrieval
==============

.. automodule:: typhon.arts.retrieval

.. currentmodule:: typhon.arts.retrieval

.. autosummary::
:toctree: generated

RetrievalQuantity

arts.scattering
===============

.. automodule:: typhon.arts.scattering

.. currentmodule:: typhon.arts.scattering

.. autosummary::
:toctree: generated

SingleScatteringData
SpectralSingleScatteringData
ScatteringMetaData

arts.sensor
===========

.. automodule:: typhon.arts.sensor

.. currentmodule:: typhon.arts.sensor

.. autosummary::
:toctree: generated

get_f_backend_rel_width
get_f_backend_const_width


arts.xml
========

.. automodule:: typhon.arts.xml

.. currentmodule:: typhon.arts.xml

.. autosummary::
:toctree: generated

load
load_directory
load_indexed
save
make_binary
make_directory_binary

arts.xsec
=========

.. automodule:: typhon.arts.xsec

.. currentmodule:: typhon.arts.xsec

.. autosummary::
:toctree: generated

XsecRecord
The arts module has moved. Its functionality has been migrated to the PyARTS
package which is available as part of the
`ARTS distribution <https://www.radiativetransfer.org/getarts/>`_.
On Linux, it can be installed with :code:`pip install pyarts`.
56 changes: 0 additions & 56 deletions doc/typhon.arts.workspace.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/typhon.plots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ plots
HectoPascalFormatter
HectoPascalLogFormatter
label_axes
plot_arts_lookup
plot_bitfield
plot_distribution_as_percentiles
profile_p
Expand Down
1 change: 0 additions & 1 deletion typhon/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
import logging
from os.path import dirname, join

from . import arts # noqa
from . import cloudmask # noqa
from . import config # noqa
from . import constants # noqa
Expand Down
13 changes: 3 additions & 10 deletions typhon/arts/__init__.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
# -*- coding: utf-8 -*-

"""This module contains functions to interact with ARTS.
"""

from typhon.arts import sensor # noqa
from typhon.arts import xml # noqa
from typhon.arts.common import * # noqa

__all__ = [s for s in dir() if not s.startswith('_')]
raise ModuleNotFoundError(
"The ARTS submodule has been migrated to PyARTS in Typhon version >0.8.0\n"
"Either install Typhon version 0.8.0 or switch to the PyARTS package")
Loading