Skip to content

Commit

Permalink
DOCS: Update version number to 3.0.3 and documentation URLs.
Browse files Browse the repository at this point in the history
  • Loading branch information
baagaard-usgs committed Dec 12, 2022
1 parent e2047b9 commit 5f5d4e0
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 18 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@

## Description

**IMPORTANT**: If you are just starting to learn how to use PyLith or wanting to run PyLith on a laptop or workstation, then we highly recommend using the binary packages. Installation instructions for binary packages are available in the PyLith manual available from the [PyLith webpage](https://geodynamics.org/cig/software/pylith/) on the [CIG website](https://geodynamics.org).
**IMPORTANT**: If you are just starting to learn how to use PyLith or wanting to run PyLith on a laptop or workstation, then we highly recommend using the binary packages. Installation instructions for binary packages are available in the PyLith manual available from the [PyLith webpage](https://geodynamics.org/resources/pylith/) on the [CIG website](https://geodynamics.org).

This installer builds the current PyLith release and its dependencies from source.

## Documentation

* [Development version](https://pylith-installer.readthedocs.io/en/latest/)
* [Stable version](heeps://pylith-installer.readthedocs.io/en/v3.0.3-0)
* See the corresponding version of the PyLith manual for v2.2.2 and earlier

## Author
Expand Down
6 changes: 3 additions & 3 deletions developer/release-announcement.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
We are pleased to announce release of PyLith Installer version 3.0.0-0.
We are pleased to announce release of PyLith Installer version 3.0.3-0.

Please submit bug reports via GitHub issues:
https://github.com/geodynamics/pylith_installer/issues
Expand All @@ -9,6 +9,6 @@ conditions.
PyLith Installer is a utility for building PyLith and its dependencies
from source on Unix flavored operating systems.

You can download the installer from https://geodynamics.org/cig/software/pylith.
You can download the installer from https://geodynamics.org/resources/pylith.

Instructions are online at https://geodynamics.github.io/pylith_installer.
Instructions are online at https://pylith-installer.readthedocs.io/en/v3.0.3-0.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
author = 'Brad T. Aagaard'

# The full version, including alpha/beta/rc tags
release = 'v3.0.0-0dev'
release = 'v3.0.3-0'


# -- General configuration ---------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/configs/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ We assume that Python was not built with the same compiler suite as MPI. The `--
If Python was built with the same compilers used to build MPI, then then you do not need the `--enable-python` option.

```bash
$HOME/src/pylith/pylith-installer-3.0.0-0/configure --enable-python --with-make-threads=8 --prefix=$HOME/pylith
$HOME/src/pylith/pylith-installer-3.0.3-0/configure --enable-python --with-make-threads=8 --prefix=$HOME/pylith
```
8 changes: 4 additions & 4 deletions docs/devenv/configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ We use the following directory structure:

```{code-block} console
pylith-developer/
├── pylith_installer-3.0.0-0 # source code for the installer
├── pylith_installer-3.0.3-0 # source code for the installer
├── build-debug # top-level directory for building with debugging
└── pylith-debug # directory where PyLith and other CIG code is installed by installer
```
Expand Down Expand Up @@ -91,7 +91,7 @@ mkdir -p $PYLITH_DIR
cd $PYLITH_DIR
# Place the installer source code tarball in $PYLITH_DIR and then unpack the tarball.
tar -xf pylith_installer-3.0.0-0.tar.gz
tar -xf pylith_installer-3.0.3-0.tar.gz
```

## Linux
Expand Down Expand Up @@ -121,7 +121,7 @@ Configure the installer.
```{code-block} bash
mkdir $PYLITH_DIR/build-debug
cd $PYLITH_DIR/build-debug
$PYLITH_DIR/pylith_installer-3.0.0-0/configure \
$PYLITH_DIR/pylith_installer-3.0.3-0/configure \
--enable-developer \
--with-debugging \
--with-pylith-git=$PYLITH_BRANCH \
Expand Down Expand Up @@ -172,7 +172,7 @@ Configure the installer.
```{code-block} bash
mkdir $PYLITH_DIR/build-debug
cd $PYLITH_DIR/build-debug
${HOME}/src/pylith/pylith_installer-3.0.0-0/configure \
${HOME}/src/pylith/pylith_installer-3.0.3-0/configure \
--enable-developer \
--with-debugging \
--with-pylith-git=$PYLITH_BRANCH \
Expand Down
2 changes: 1 addition & 1 deletion docs/devenv/docker/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Pulling the PyLith development environment Docker image does not update Pythia,

## Updating PETSc or PyLith

See [Rebuilding PETSc and PyLith in the PyLith Developer Guide](https://pylith.readthedocs.io/en/latest/developer/contributing/rebuilding.html) for how to update PETSc and PyLith.
See [Rebuilding PETSc and PyLith in the PyLith Developer Guide](https://pylith.readthedocs.io/en/v3.0.3/developer/contributing/rebuilding.html) for how to update PETSc and PyLith.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This utility builds the current PyLith release and its dependencies from source.

:::{important}
If you are just starting to learn how to use PyLith or wanting to run PyLith on a laptop or workstation, then we highly recommend using the binary packages.
Installation instructions for binary packages are available in the PyLith manual available from the [PyLith webpage](https://geodynamics.org/cig/software/pylith/) on the [CIG website](https://geodynamics.org).
Installation instructions for binary packages are available in the PyLith manual available from the [PyLith webpage](https://geodynamics.org/resources/pylith/) on the [CIG website](https://geodynamics.org).
:::


Expand Down
2 changes: 1 addition & 1 deletion docs/install/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The default configure options assume you have:
In this case, you simply specify the number of threads and the destination directory:
```bash
mkdir -p $HOME/build/pylith
$HOME/src/pylith/pylith-installer-3.0.0-0/configure --with-make-threads=2 --prefix=$HOME/pylith
$HOME/src/pylith/pylith-installer-3.0.3-0/configure --with-make-threads=2 --prefix=$HOME/pylith
```

## Configure options
Expand Down
10 changes: 5 additions & 5 deletions docs/install/download.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# 1. Download the installer

## Download the installer from the CIG website.
## Download the installer from the CIG website

<https://geodynamics.org/cig/software/pylith/pylith-installer-3.0.0-0.tgz>
<https://geodynamics.org/resources/pylith>

We assume the tarball `pylith-installer-3.0.0-0.tgz` is downloaded to `$HOME/Downloads`. We will place the installer source code in the directory `$HOME/src/pylith`.
We assume the tarball `pylith-installer-3.0.3-0.tgz` is downloaded to `$HOME/Downloads`. We will place the installer source code in the directory `$HOME/src/pylith`.

## Unpack the installer source code:

```bash
mkdir -p $HOME/src/pylith
cd $HOME/src/pylith
mv $HOME/Downloads/pylith-installer-3.0.0-0.tgz $HOME/src/pylith/
tar -xf pylith-installer-3.0.0-0.tgz
mv $HOME/Downloads/pylith-installer-3.0.3-0.tgz $HOME/src/pylith/
tar -xf pylith-installer-3.0.3-0.tgz
```

0 comments on commit 5f5d4e0

Please sign in to comment.