Skip to content

Commit 4b1de8f

Browse files
authored
Update README.md
Updating links and adding minor text edits.
1 parent ef4e211 commit 4b1de8f

File tree

1 file changed

+16
-60
lines changed

1 file changed

+16
-60
lines changed

README.md

Lines changed: 16 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Madagascar
88
[![SourceForge](https://img.shields.io/sourceforge/dt/rsf.svg)](https://sourceforge.net/projects/rsf/)
99
[![codecov](https://codecov.io/gh/ahay/src/branch/master/graph/badge.svg?token=sY69nxugpL)](https://codecov.io/gh/ahay/src)
1010
[![join slack](https://img.shields.io/badge/slack-Madagascar-orange.svg?logo=slack )](https://join.slack.com/t/ahayorg/shared_invite/zt-hkyvgitg-M2E_TTgg6G1pL2664ax~QQ)
11-
### A package for reproducible geophysical data processing
11+
### A package for reproducible geophysical data analysis
1212

13-
http://www.ahay.org
13+
https://www.reproducibility.org
1414

1515
## What is Madagascar?
1616

@@ -30,78 +30,34 @@ be verified, exchanged, and modified by users of the system.
3030

3131
## Design Principles
3232

33-
* Madagascar is a modern package. Started in 2003 and publicly released in
34-
2006, it was developed entirely from scratch following modern software engineering
35-
practices such as moduleencapsulation and test-driven development. A rapid development
36-
of a projectof this scope (more than 300 main programs and more than 3,000 tests) would
37-
not be possible without standing on the shoulders of giants and learning
38-
from the 30 years of previous experience in open packages such as SEPlib and
39-
Seismic Unix. We have borrowed and reimplemented functionality and ideas
40-
from these other packages.
41-
42-
* Madagascar is a test-driven package. Test-driven development is not only an
43-
agile software programming practice but also a way of bringing scientific
44-
foundation to geophysical research that involves numerical experiments.
45-
Bringing reproducibility and peer review, the backbone of any real science,
46-
to the field of computational geophysics is the main motivation for
47-
Madagascar development. The package consists of two levels: low-level main
48-
programs (typically developed in the C programming language and working as
49-
data filters) and high-level processing flows (described with the help of
50-
the Python programming language) that combine main programs and completely
51-
document data processing histories for testing and reproducibility.
52-
Experience shows that high-level programming is easily mastered even by
53-
beginning students that have no previous programming experience.
54-
55-
* Madagascar is an open-source package. It is distributed under the standard
56-
GPL open-source license, which places no restriction on the usage and
57-
modification of the code. Moreover, access to modifying the source
58-
repository is not controlled by one organization but shared equally among
59-
different developers. This enables an open collaboration among different
60-
groups spread all over the world, in the true spirit of the open source
61-
movement.
62-
63-
* Madagascar uses a simple, flexible, and universal data format that can
64-
handle very large datasets but is not tied specifically to seismic data or
65-
data of any other particular kind. This "regularly sampled" format is
66-
borrowed from the traditional SEPlib. A universal data format allows us to
67-
share general-purpose data processing tools with scientists from other
68-
disciplines such as petroleum engineers working on large-scale reservoir
69-
simulations.
33+
* Madagascar is a modern package. Started in 2003 and publicly released in 2006, it was developed entirely from scratch following modern software engineering practices such as module encapsulation and test-driven development. A rapid development of a project of this scope (more than 300 main programs and more than 3,000 tests) would not be possible without standing on the shoulders of giants and learning from 30 years of previous experience in open packages such as SEPlib and Seismic Unix. We have borrowed and reimplemented functionality and ideas from these other packages.
7034

71-
## Where to get more information about Madagascar
35+
* Madagascar is a test-driven package. Test-driven development is an agile software programming practice and a way of bringing a scientific foundation to geophysical research involving numerical experiments. Bringing reproducibility and peer review, the backbone of any real science, to computational geophysics is the primary motivation for Madagascar's development. The package consists of two levels: low-level main programs (typically developed in the C programming language and working as data filters) and high-level processing flows (described with the help of the Python programming language) that combine main programs and completely document data processing histories for testing and reproducibility. Experience shows that high-level programming is easily mastered even by beginning students with no previous programming experience.
7236

73-
The primary source of information is the web site:
37+
* Madagascar is an open-source package. It is distributed under the standard GPL open-source license, which does not restrict the usage and modification of the code. Moreover, access to modifying the source repository is not controlled by one organization but shared equally among developers. This setup enables an open collaboration among different groups to spread worldwide in the true spirit of the open-source movement.
7438

75-
http://www.ahay.org/
39+
* Madagascar uses a simple, flexible, and universal data format that can handle very large datasets but is not tied specifically to seismic data or data of any particular kind. This "regularly sampled" format is borrowed from the traditional SEPlib. A universal data format allows us to share general-purpose data processing tools with scientists from other disciplines, such as petroleum engineers working on large-scale reservoir simulations.
7640

77-
Additional information:
41+
## Where to get more information about Madagascar
7842

79-
users' mailing list ("RSF-user"):
43+
The primary source of information is the website:
8044

81-
https://lists.sourceforge.net/lists/listinfo/rsf-user
45+
https://www.reproducibility.org/
8246

83-
developers' mailing list ("RSF-devel"):
47+
Additional information:
8448

85-
https://lists.sourceforge.net/lists/listinfo/rsf-devel
49+
* Users' mailing list ("RSF-user"): https://lists.sourceforge.net/lists/listinfo/rsf-user
8650

87-
development blog:
51+
* Developers' mailing list ("RSF-devel"): https://lists.sourceforge.net/lists/listinfo/rsf-devel
8852

89-
http://ahay.org/blog/
53+
* Development blog: http://ahay.org/blog/
9054

9155
## Compiling, Building, Installing and Testing
9256

9357
See the INSTALL.txt document for build instructions.
9458

9559
## History
9660

97-
While being written from scratch, Madagascar borrows ideas from the
98-
design of SEPlib, a publicly available software package, maintained by
99-
Bob Clapp at the Stanford Exploration Project (SEP). Generations of
100-
SEP students and researchers contributed to SEPlib. Most important
101-
contributions came from Rob Clayton, Jon Claerbout, Dave Hale, Stew
102-
Levin, Rick Ottolini, Joe Dellinger, Steve Cole, Dave Nichols, Martin
103-
Karrenbach, Biondo Biondi, and Bob Clapp.
104-
105-
Madagascar was started, under the name RSF (Regularly Sampled Format)
106-
by Sergey Fomel in 2003. Since then, many other people have
107-
contributed to it. See the AUTHORS.txt file for an incomplete list.
61+
While written from scratch, Madagascar borrows ideas from the design of SEPlib, a publicly available software package maintained by Bob Clapp at the Stanford Exploration Project (SEP). Generations of SEP students and researchers contributed to SEPlib. The most significant contributions came from Rob Clayton, Jon Claerbout, Dave Hale, Stew Levin, Rick Ottolini, Joe Dellinger, Steve Cole, Dave Nichols, Martin Karrenbach, Biondo Biondi, and Bob Clapp.
62+
63+
Madagascar was started in 2003 under the name RSF (Regularly Sampled Format) by Sergey Fomel. Since then, many other people have contributed to it. See the AUTHORS.txt file for an incomplete list.

0 commit comments

Comments
 (0)