Skip to content

Update branches section on Readme and add small section linking to ModEM online docs #85

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.

Sign up for GitHub

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

Merged
MiCurry merged 2 commits into from
Sep 16, 2026
Merged

Update branches section on Readme and add small section linking to ModEM online docs #85

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d880ec
Move old branches section in Readme to branches section
MiCurry Sep 8, 2026
78c9b56
Create a small section linking to the ModEM docs
MiCurry Sep 8, 2026
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
43 changes: 25 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,13 @@ Modular Electromagnetic Inversion Software (ModEM)

[![DOI](https://zenodo.org/badge/1025134680.svg)](https://doi.org/10.5281/zenodo.17229555)

[ModEM Documentation](https://magnetotellurics.github.io/ModEM/)

> **NOTE:** This repository has been converted from the ModEM's OSU CEOAS Subversion
> (SVN) repository. SVN revisions have been preserved and converted into Git
> commits. Some main branches have been renamed:
>
> | SVN Branch Name | GitHub Branch Name |
> | --------------- | -------------------|
> | trunk | [trunk][trunk-branch] |
> | stable- | [main][main-branch] |
> | stable | [classic][classic-branch] |
>
> Furthermore, the `matlab` and `examples` directory have been moved into the
> [ModEM-Tools][ModEM-Tools] and [ModEM-Examples][ModEM-Examples] repositories,
> respectively.

[trunk-branch]: https://github.com/magnetotellurics/ModEM/tree/trunk
[main-branch]: https://github.com/magnetotellurics/ModEM/tree/main
[classic-branch]: https://github.com/magnetotellurics/ModEM/tree/classic

# Contents

* [Obtaining The Software](#obtaining-the-software)
* [Branches](#branches)
* [ModEM Documentation](#modem-documentation)
* [Building ModEM](#building-modem)
* [Dependencies](#dependencies)
* [Creating Makefiles From Configuration files](#creating-makefiles-from-configuration-files)
Expand Down Expand Up @@ -78,10 +62,33 @@ ModEM currently has two branches used for development:
stable then develop.
* [develop][develop-branch] - The branch that contains the newest code, that may be less stable
than main and may contain bugs.


> **NOTE:** This repository has been converted from the ModEM's OSU CEOAS Subversion
> (SVN) repository. SVN revisions have been preserved and converted into Git
> commits. Some main branches have been renamed:
>
> | SVN Branch Name | GitHub Branch Name |
> | --------------- | -------------------|
> | stable- | [main][main-branch] |
> | stable | [classic][classic-branch] |
>
> Furthermore, the `matlab` and `examples` directory have been moved into the
> [ModEM-Tools][ModEM-Tools] and [ModEM-Examples][ModEM-Examples] repositories,
> respectively.

[trunk-branch]: https://github.com/magnetotellurics/ModEM/tree/trunk
[main-branch]: https://github.com/magnetotellurics/ModEM/tree/main
[classic-branch]: https://github.com/magnetotellurics/ModEM/tree/classic

[main-branch]: https://github.com/magnetotellurics/ModEM/
[develop-branch]: https://github.com/magnetotellurics/ModEM/tree/develop

## ModEM Documentation

The ModEM Documentation can now be found online at:
https://magnetotellurics.github.io/ModEM/.

# Building ModEM

## Dependencies
Expand Down
Loading