Skip to main content

Craterstats - a tool to analyse and plot crater count data for planetary surface dating

Project description

Craterstats

This is a reimplementation in Python 3.8 of the CraterstatsII software, a tool to analyse and plot crater count data for planetary surface dating.

Installation

There are various ways to install Python. If you are installing it specifically to run Craterstats, the following is suggested:

  1. Install Python 3.8 or higher from python.org.
  2. Download Craterstats and unzip the files where you choose.
  3. Open a command prompt/terminal window and cd to the newly-created craterstats-main/
  4. Enter these commands to establish a Python virtual environment:

Windows:

py -m venv c:\craterstats
c:\craterstats\Scripts\activate
py -m pip install craterstats

Linux:

python3 -m venv ~/.craterstats
source ~/.craterstats/bin/activate
python3 -m pip install craterstats

After you see the required python packages installed, the set-up is complete.

Quick demonstration

After installation, the following commands will produce a series of example output plots and data, demonstrating the main features of the software. Plot image files are placed into the subfolder demo/, while text output – including the full command lines as they could be typed to generate the output – goes to the terminal window.

craterstats -demo

Normal start

Open a command prompt/terminal window and run the activate script:

Windows:

c:\craterstats\Scripts\activate

Linux:

source ~/.craterstats/bin/activate

Usage

The program operates through the command line to produce output in the form of publication or presentation ready graphics, or tabulated analysis results for further processing.

There are two parts to creating a Craterstats plot:

  1. Specify the type of plot and any characteristics which apply to the analysis as a whole, e.g. whether differential, cumulative of other data presentation; the chronology system, displayed axis ranges

  2. Specify the data to be overplotted, and which chronology model evaluations should be applied to it

In the following example, the first items define characteristics for the whole plot: -cs neukumivanov specifies chronology system 4, Mars, Neukum-Ivanov (2001) , and the -title Example plot adds the chosen title.

The -p indicates the start of an overplot definition, which should come after the part 1 settings. Following this, the path to the data source is given: this will produce a simple data plot with the default binning, colour and plot symbol. After the second -p, an additional overplot is specified: this time, a poisson age evaluation for the diameter range 0.2–0.7 km. Note that parameters within an overplot definition are separated by a ,.

craterstats -cs neukumivanov -title Example plot -p source=craterstats/sample/Pickering.scc -p type=poisson,range=[.2,.7]

By default, an output file is created in the current folder with the name out.png. The output path or name can be set with the -o option. Different file types can be produced by giving the appropriate extension or with the -f option. Supported types are: png, jpg, tif, pdf, svg, txt.

Tables of chronology systems, equilibrium functions and epoch systems – which can be used with the -cs, -ef and -ep options – may be listed with the following command:

craterstats -lcs

These items may specifed by their index number, e.g. -cs 4, or using any unambiguous abbreviated form, e.g. -cs ida. Similarly, -ef standard or -ef trask is equivalent to -ef 1

Numbered tables of plot symbols and colours – which can be used with the psym= and colour= options – may be listed with the following command:

craterstats -lpc

and can likewise be specified by index or abbreviation, e.g. psym=1, psym=circle or psym=o all select a circle; colour=2, colour=green or colour=gr select green.

Differential plots are produced by default. To switch to a different kind, e.g. cumulative, add -pr 1 or -pr cum to the part 1 settings. Other possibilities are: 3 - relative (R), 4 - Hartmann, 5 - chronology, 6 - rate.

The complete set of options can be seen with:

craterstats --help

Additional information

The useable chronology systems, equilibrium functions and epoch systems are defined in the text file config/functions.txt. User functions may be added here, following the same format.

There is a text file config/default.plt which contains all the default plot settings. This may be modified to suit the choices you use most often.

To simplify the construction of the command line, certain plot properties are 'sticky'. If, for example, you specify source=craterstats/sample/Pickering.scc in the first overplot, this becomes the default for subsequent overplots. Only if you wish to introduce a different source file do you need to specify it again. This applies to other properties where it is useful, including binning=, colour= and psym=.

References

Explanations of concepts and calculations used in the software are given in publications below.

Standardisation of crater count data presentation

Arvidson, R.E., Boyce, J., Chapman, C., Cintala, M., Fulchignoni, M., Moore, H., Neukum, G., Schultz, P., Soderblom, L., Strom, R., Woronow, A., Young, R. Standard techniques for presentation and analysis of crater size–frequency data. Icarus 37, 1979.

Formulation of a planetary surface chronology model

Neukum G., Meteorite bombardment and dating of planetary surfaces (English translation, 1984). Meteoritenbombardement und Datierung planetarer Oberflächen (German original) Habilitation Thesis, Univ. of Munich, 186pp, 1983.

Resurfacing correction for cumulative fits; production function differential forms

Michael G.G., Neukum G., Planetary surface dating from crater size-frequency distribution measurements: Partial resurfacing events and statistical age uncertainty. Earth and Planetary Science Letters 294, 2010.

Differential fitting; binning bias correction; revised Mars epoch boundaries

Michael G.G., Planetary surface dating from crater size-frequency distribution measurements: Multiple resurfacing episodes and differential isochron fitting. Icarus 2013.

Poisson timing analysis; μ-notation

Michael G.G., Kneissl T., Neesemann A., Planetary surface dating from crater size-frequency distribution measurements: Poisson timing analysis. Icarus, 2016.

Poisson calculation for buffered crater count

Michael G.G., Yue Z., Gou S., Di K., Dating individual several-km lunar impact craters from the rim annulus in region of planned Chang’E-5 landing Poisson age-likelihood calculation. EPSL 568, 2021.

Full references for specific chronology or other functions are listed with the function definitions in config/functions.txt.

A set of introductory slides from a previous workshop is available here: ftp://pdsimage2.wr.usgs.gov/pub/pigpen/tutorials/FreieUni_Workshop2012/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

craterstats-3.0.6.tar.gz (99.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

craterstats-3.0.6-py3-none-any.whl (113.7 kB view details)

Uploaded Python 3

File details

Details for the file craterstats-3.0.6.tar.gz.

File metadata

  • Download URL: craterstats-3.0.6.tar.gz
  • Upload date:
  • Size: 99.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.8.15

File hashes

Hashes for craterstats-3.0.6.tar.gz
Algorithm Hash digest
SHA256 1091d902626bff6c8a7221d3dd9856a59e60c9b7d55d98226ecb1364ce6b07d7
MD5 ed2073217116b49411ff111ee07780ec
BLAKE2b-256 41af93c18f793f0f887095a8b8b06a0e5655c95cf95cf73b57ea938b3ddd5d5a

See more details on using hashes here.

File details

Details for the file craterstats-3.0.6-py3-none-any.whl.

File metadata

  • Download URL: craterstats-3.0.6-py3-none-any.whl
  • Upload date:
  • Size: 113.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.8.15

File hashes

Hashes for craterstats-3.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e945d07e1cf3984d5fda647f4a24bc538cc9ae29de2138f6c1d1b8270e94da35
MD5 cdd1bc5d5c8300e33eeac7e262fab732
BLAKE2b-256 ed8088a681ac30a8f34888e539dc6e5db73afbcde32faa1d50552381a2537092

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page