Skip to content

Toolkit for interfacing with shear-wave splitting codes.

License

Notifications You must be signed in to change notification settings

hemmelig/AnisotropIO

Repository files navigation

AnisotropIO is a cross-platform Python toolkit for parsing, composing, and translating between inputs/outputs for various shear-wave splitting analysis codes.

Key features

AnisotropIO is a sibling Python package to AnisotroPy, providing a standard, unified file format and internal representation used for shear-wave splitting analyses.

AnisotropIO currently provides parsers for:

  • MFAST
  • SplitRacer

More to come.

Documentation

Documentation for AnisotropIO is hosted here.

Installation

AnisotropIO requires Python version 3.8 and above. Installation of AnisotropIO, including all dependencies, can be done using pip:

pip install --extra_index_url https://test.pypi.org/simple/ anisotropio

For further information regarding installation—including virtual environment management and installation from source—please consult our documentation.

Citation

If you use AnisotropIO in your work, please cite the following:

Bacon, C. A. (2023). AnisotropIO (Version 0.0.1) [Computer software]. https://doi.org/XX.XXXX/zenodo.XXXXXXX

Contributing to AnisotropIO

Contributions to AnisotropIO are welcomed. The first stop should be to reach out, either directly or—preferably—via the GitHub Issues panel, to discuss the proposed changes. Next, simply fork the AnisotropIO repository, make your changes/add your new contribution, then make a pull request. All contributors to AnisotropIO will be listed as authors on the releases.

Bug reports, suggestions for new features and enhancements, and even links to projects that have made use of AnisotropIO are most welcome.

See our contributions page for more information.

Contact

Any comments/questions can be directed to:

  • Conor Bacon - cbacon [ at ] ldeo.columbia.edu

License

AnisotropIO is free and open source, distributed under the GPLv3 License. Please see the LICENSE file for a complete description of the rights and freedoms that this provides the user.

About

Toolkit for interfacing with shear-wave splitting codes.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages