Skip to content

Commit

Permalink
Some text corrections and adjustments (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
Patol75 authored Jun 25, 2024
1 parent 98ee8e7 commit 42f4422
Show file tree
Hide file tree
Showing 10 changed files with 68 additions and 70 deletions.
2 changes: 1 addition & 1 deletion docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ method;
2. [dolfin-adjoint](https://github.com/dolfin-adjoint/pyadjoint), an algorithmic
differentiation framework that automatically derives the corresponding representation
of discrete adjoint equations in a form compatible with Firedrake;
3. [Rapid Optimisation Library(ROL)](https://trilinos.github.io/rol.html), a highly
3. [Rapid Optimisation Library (ROL)](https://trilinos.github.io/rol.html), a highly
efficient package enabling advanced, large-scale optimization.

Together, they constitute a high-performance geoscientific modelling framework with
Expand Down
14 changes: 7 additions & 7 deletions docs/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ hide:
# Contact

Please get in contact if our web material and tutorials do not answer your questions, if you run into problems that you cannot solve,
or if you'd like to get involved in developing G-ADOPT.
or if you would like to get involved in developing G-ADOPT.

**GitHub**

: G-ADOPT is developed publicly on [GitHub](https://github.com/g-adopt/g-adopt). If you have a bug to report or a new feature to request, please
raise an [issue](https://github.com/g-adopt/g-adopt/issues) or open a [discussion](https://github.com/g-adopt/g-adopt/discussions) on our project page.
If you're using G-ADOPT regularly, this is where we'll announce important changes like bug fixes or new features.
If you're using G-ADOPT regularly, this is where we will announce important changes like bug fixes or new features.

**Slack**

: Some of our development discussions take place on the Firedrake slack workspace. This
workspace is open to all but you'll need to request an invitation. See [this page](https://www.firedrakeproject.org/contact.html) for instructions.
Once you have access you can then join the #gadopt channel. Slack chat history disappears after 90 days,
and whilst it is as a sensible avenue for quick correspondence, our preference would be for important
: Some of our development discussions take place on the Firedrake Slack workspace. This
workspace is open to all but you will need to request an invitation; see [this page](https://www.firedrakeproject.org/contact.html) for instructions.
Once you have access you can then join the *#gadopt* channel. Slack chat history disappears after 90 days,
and whilst it is a sensible avenue for quick correspondence, our preference would be for important
issues and discussions to be raised on GitHub.

**Email**

: You can email the G-ADOPT project team at <[email protected]>.
: You can email the G-ADOPT project team at <[email protected]> for any other request.
6 changes: 3 additions & 3 deletions docs/events.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Media and Outreach

Below are examples of recent blogs and media articles associated with the G-ADOPT platform.
Below are examples of recent blogs and media articles associated with the G-ADOPT platform:

1. EGU blog article (11/2022): [A next-generation computational modelling framework for geodynamics](https://blogs.egu.eu/divisions/gd/2022/11/21/g-adopt-a-next-generation-computational-modelling-framework-for-geodynamics).
2. ARDC Newsletter (02/2024): [A versatile tool for tackling grand challenges for Earth Sciences](https://ardc.edu.au/article/versatile-modelling-tool-to-help-tackle-grand-challenges-for-earth/).
1. EGU blog article (11/2022): [A next-generation computational modelling framework for geodynamics](https://blogs.egu.eu/divisions/gd/2022/11/21/g-adopt-a-next-generation-computational-modelling-framework-for-geodynamics)
2. ARDC Newsletter (02/2024): [A versatile tool for tackling grand challenges for Earth Sciences](https://ardc.edu.au/article/versatile-modelling-tool-to-help-tackle-grand-challenges-for-earth/)
2 changes: 1 addition & 1 deletion docs/events/workshops/posts/2022-workshop.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ date: 2022-04-28
![2022 Workshop Tutorial](../../../images/events/2022_workshop_tutorial.jpg "2022 Workshop Tutorial"){ width="200" loading=lazy }
![2022 Workshop Dinner](../../../images/events/2022_workshop_dinner.jpg "2022 Workshop Dinner"){ width="200" loading=lazy }

The first G-ADOPT workshop was help on 28/04/22-29/04/22 at the Australian National University. This workshop provided an opportunity for the G-ADOPT development team to showcase progress on the forward modelling component of our platform, using the Firedrake framework. The overarching goal of the workshop was to provide a background to the platform and training for potential users, thus facilitating community growth within Australia. Although our focus was on geodynamical application, we also identified other research areas for future applicability. There was an opportunity for interested practitioners to engage with developers and other participants, to ascertain whether their problems are tractable within Firedrake.
The first G-ADOPT workshop was held on 28/04/22-29/04/22 at the Australian National University. This workshop provided an opportunity for the G-ADOPT development team to showcase progress on the forward modelling component of our platform, using the Firedrake framework. The overarching goal of the workshop was to provide a background to the platform and training for potential users, thus facilitating community growth within Australia. Although our focus was on geodynamical application, we also identified other research areas for future applicability. There was an opportunity for interested practitioners to engage with developers and other participants to ascertain whether their problems are tractable within Firedrake.
10 changes: 5 additions & 5 deletions docs/events/workshops/posts/2024-workshop.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ date: 2024-02-13

# G-ADOPT Workshop 2024

The 2024 G-ADOPT workshop will be held at the [ANU's Kioloa Coastal Campus](https://www.anu.edu.au/about/campuses-facilities/kioloa-coastal-campus) on the New South Wales coast. Mark your diaries for **Sunday 10/11/24 (4 pm) - Tuesday 12/11/24 (4 pm)**.
The 2024 G-ADOPT workshop will be held at the [ANU's Kioloa Coastal Campus](https://www.anu.edu.au/about/campuses-facilities/kioloa-coastal-campus) on the New South Wales coast. Mark your diaries for **Sunday 10/11/24 (4 pm) - Tuesday 12/11/24 (4 pm)**.

The workshop will provide background to the platform and training for potential users, thus facilitating community growth. We welcome national and international participants. The workshop will provide an opportunity for the G-ADOPT team to showcase recent progress on the forward and adjoint components of this finite element modelling platform. Key areas of focus will include:

1. Mantle and lithosphere dynamics.
2. Glacial isostatic adjustment and visco-elasticity.
3. Multi-material simulations.
1. Mantle and lithosphere dynamics;
2. Glacial isostatic adjustment and visco-elasticity;
3. Multi-material simulations;
4. Adjoint-based optimisation problems.

Thanks to generous support from our partners at [AuScope](https://www.auscope.org.au/), this workshop will be free for all students and early career academics, provided registration is complete before the **early-bird registration deadline of 30/06/2024**. Student and early-career registrations after this date require a contribution of $50. Registration for other participants will be $200 prior to the early-bird registration deadline, and $250 thereafter.
Thanks to generous support from our partners at [AuScope](https://www.auscope.org.au/), this workshop will be free for all students and early-career academics, provided registration is complete before the **early-bird registration deadline of 30/06/2024**. Student and early-career registrations after this date require a contribution of $50. Registration for other participants will be $200 prior to the early-bird registration deadline, and $250 thereafter.

## [Register Here](https://payments.anu.edu.au/GADOPT2024)

38 changes: 19 additions & 19 deletions docs/funding.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
# Funding and Partners

## Background
G-ADOPT was initiated and funded within the Australian Research Data Commons (ARDC) [2020 platforms call](https://doi.org/10.47486/PL031), which invested in platforms that would transform the way research is conducted in various disciplines. G-ADOPT is short for ‘Geoscientific ADjoint Optimization PlaTform’. At first, though, the ‘G’ stood for ‘Geodynamic’ when the platform had a tighter focus. G-ADOPT is now applied across many branches of geosciences, including groundwater simulation, optimisation for renewable energy generation, and simulating the solid Earth's response to melting polar ice sheets. In 2023, the platform received funding from AuScope, to focus, in particular, on the latter challenge.
G-ADOPT was initiated and funded within the Australian Research Data Commons (ARDC) [2020 platforms program](https://doi.org/10.47486/PL031), which invested in platforms that would transform the way research is conducted in various disciplines. G-ADOPT is short for ‘Geoscientific ADjoint Optimization PlaTform’. At first, though, the ‘G’ stood for ‘Geodynamic’ when the platform had a tighter focus. G-ADOPT is now applied across many branches of geosciences, including groundwater simulation, optimisation for renewable energy generation, and Earth's response to melting polar ice sheets. In 2023, the platform received funding from AuScope to focus, in particular, on the latter challenge.

## Specific Funding Awards and Grants

1. **2020 - ARDC Platform Grant** - Geodynamic ADjoint Optimization PlaTform (PL031).
**Funding**: $1,355,492.
**Purpose**: To develop transformational new research software infrasturcutre for inverse geodynamical simulation.
**CIs**: D. R. Davies (ANU), S. Ghelichkhan (ANU), K. Czarnota (GA), D. Müller (USyd), S. C. Kramer (Imperial College London), D. Ham (Imperial College London), S. Funke (Simula Research Laboratories), P. E. Farrell (Oxford University), M. Sambridge (ANU), M. Seton (USyd), S. D. B. Goes (Imperial College London), B. Evans (NCI), T. Rawling (AuScope).
1. **2020 --- ARDC Platform Grant** --- Geodynamic ADjoint Optimization PlaTform (PL031).
**Funding**: A$1,355,492.
**Purpose**: To develop transformational new research software infrastructure for inverse geodynamical simulation.
**CIs**: D. R. Davies (ANU), S. Ghelichkhan (ANU), K. Czarnota (GA), D. Müller (USyd), S. C. Kramer (Imperial College London), D. Ham (Imperial College London), S. Funke (Simula Research Laboratories), P. E. Farrell (Oxford University), M. Sambridge (ANU), M. Seton (USyd), S. D. B. Goes (Imperial College London), B. Evans (NCI), T. Rawling (AuScope).

2. **2022 - Australian Centre for Excellence in Antarctic Science (ACEAS)** - Simulating Glacial Isostatic Adjustment in Firedrake.
**Funding**: ~$600,000.
**Purpose**: To develop G-ADOPT research software infrastructure for simulating Glacial Isostatic Adjustment (GIA) and solid Earth impacts on sea level.
2. **2022 --- Australian Centre for Excellence in Antarctic Science (ACEAS)** --- Simulating Glacial Isostatic Adjustment in Firedrake.
**Funding**: ~A$600,000.
**Purpose**: To develop G-ADOPT research software infrastructure for simulating Glacial Isostatic Adjustment (GIA) and solid Earth impacts on sea level.
**CIs**: D. R. Davies (ANU), M. J. Hoggard (ANU), S. Ghelichkhan (ANU), A. Gibson (ANU), W. Scott (ANU).

3. **2023 - AuScope 2023 NCRIS Research Infrastructure Investment Plan (RIIP) - Coastal Research Infrastructure (CoastRI)**.
**Funding**: $1,418,350.
**Purpose**: To support development and maintenance of G-ADOPT’s research software infrastructure for simulating Glacial Isostatic Adjustment (GIA) and solid Earth impacts on sea level (for example, through dynamic topography).
3. **2023 --- AuScope 2023 NCRIS Research Infrastructure Investment Plan (RIIP) --- Coastal Research Infrastructure (CoastRI)**.
**Funding**: A$1,418,350.
**Purpose**: To support development and maintenance of G-ADOPT’s research software infrastructure for simulating Glacial Isostatic Adjustment (GIA) and solid Earth impacts on sea level (for example, through dynamic topography).
**CIs**: D. R. Davies (ANU), M. J. Hoggard (ANU), S. Ghelichkhan (ANU), S. C. Kramer (Imperial College London), A. Gibson (ANU), A. Hogg (ACCESS-NRI), T. Rawling (AuScope).

4. **2024 - ANU Institute for Water Futures (IWF)**
**Funding**: ~$500,000.
**Purpose**: To develop G-ADOPT based research software infrastructure for digital twins of groundwater systems.
**CIs**: S. Ghelichkhan (ANU), D. R. Davies (ANU), A. Gibson (ANU).
4. **2024 --- ANU Institute for Water Futures (IWF)**.
**Funding**: ~A$500,000.
**Purpose**: To develop G-ADOPT-based research software infrastructure for digital twins of groundwater systems.
**CIs**: S. Ghelichkhan (ANU), D. R. Davies (ANU), A. Gibson (ANU).

## Partners
[![ARDC logo](images/ardc_logo.svg "ARDC logo"){ align=right width="200" }](https://ardc.edu.au/)
The Australian Research Data Commons (ARDC) is a transformational initiative that enables Australian research community and industry access to nationally significant, leading edge data intensive infrastructure, platforms, skills and collections of high-quality data. In partnerships with organisations, the ARDC leads facilitations that work towards a coherent research environment to enable researchers to find, access, contribute to and effectively use services to maximise research quality and impact. The ARDC is funded by the Australian Government's National Collaborative Research Infrastructure Strategy (NCRIS).
The Australian Research Data Commons (ARDC) is a transformational initiative that provides Australian research community and industry with access to nationally significant, leading-edge data-intensive infrastructure, platforms, skills, and collections of high-quality data. In partnerships with organisations, the ARDC leads facilitations that work towards a coherent research environment to enable researchers to find, access, contribute to, and effectively use services to maximise research quality and impact. The ARDC is funded by the Australian Government's National Collaborative Research Infrastructure Strategy (NCRIS).

---

Expand All @@ -37,12 +37,12 @@ AuScope provides geoscientists with a world-class research ‘toolkit’ to help
---

[![NCI logo](images/nci_logo.svg "NCI logo"){ align=right width="200" }](https://nci.org.au/)
The National Computational Infrastructure (NCI) is Australia’s leading high-performance data, storage and computing organisation, providing expert services to benefit all domains of science, government and industry. NCI brings the Australian Government and the Australian research sector together through a broad collaboration involving the largest national science agencies, universities, industry and the Australian Research Council. NCI is supported by the Australian Government's National Collaborative Research Infrastructure Strategy (NCRIS)
The National Computational Infrastructure (NCI) is Australia’s leading high-performance data, storage, and computing organisation, providing expert services to benefit all domains of science, government, and industry. NCI brings the Australian Government and the Australian research sector together through a broad collaboration involving the largest national science agencies, universities, industry and the Australian Research Council. NCI is supported by the Australian Government's National Collaborative Research Infrastructure Strategy (NCRIS)

---

[![ACCESS-NRI logo](images/access_nri_logo.svg "ACCESS NRI logo"){ align=right width="200" }](https://www.access-nri.org.au/)
The Australian Earth-System Simulator (ACCESS-NRI) is a national research Infrastructure created to support development and research with the Australian Community Climate and Earth System Simulator (ACCESS) modelling system framework. ACCESS simulates past, present and future climate, weather and Earth-Systems.
The Australian Earth-System Simulator (ACCESS-NRI) is a national research Infrastructure created to support development and research with the Australian Community Climate and Earth System Simulator (ACCESS) modelling system framework. ACCESS simulates past, present, and future climate, weather, and Earth-Systems.

---

Expand All @@ -52,7 +52,7 @@ Geoscience Australia is Australia's pre-eminent public sector geoscience organis
---

[![Australian Research Council logo](images/arc_logo.svg "Australian Research Council logo"){ align=right width="200" }](https://www.arc.gov.au/)
The Australian Research Council's purpose is to `grow knowledge and innovation for the benefit of the Australian community through funding the highest quality research, assessing the quality, engagement and impact of research, and providing advice on research matters'.
The Australian Research Council's purpose is to `grow knowledge and innovation for the benefit of the Australian community through funding the highest quality research, assessing the quality, engagement, and impact of research, and providing advice on research matters'.

---

Expand Down
15 changes: 7 additions & 8 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ title: Install

# Installing the G-ADOPT library

First of all, you need to install [Firedrake](https://www.firedrakeproject.org), the finite element framework that G-ADOPT is built on.
Firedrake is available for Ubuntu, Mac and in principle other Linux and Linux-like systems.
First of all, you need to install [Firedrake](https://www.firedrakeproject.org), the finite element framework underpinning G-ADOPT.
Firedrake is available for Ubuntu, Mac, and, in principle, other Linux and Linux-like systems.

You can install both Firedrake and G-ADOPT by running:

Expand All @@ -18,12 +18,12 @@ up to one hour depending on your system.

## Using the G-ADOPT library

If you'd like to run G-ADOPT through scripts or interactively, simply
If you would like to run G-ADOPT through scripts or interactively, simply
ensure that your Firedrake environment is activated:

source firedrake/bin/activate

And the `gadopt` Python module should be available for you to use.
Furthermore, the `gadopt` Python module should be available for you to use.

## Run the tutorials

Expand Down Expand Up @@ -51,7 +51,7 @@ tutorial! Start the notebook server:
jupyter notebook

Within the browser window that pops up, you can browse to the
`g-adopt/demos` directory, and open any Python script with the `.py`
`g-adopt/demos` directory and open any Python script with the `.py`
extension as a notebook.

## Visualisation software
Expand All @@ -69,13 +69,12 @@ and then install the optimisation variant:

## Developing G-ADOPT

If you are keen to make changes to the core G-ADOPT code (and you want to work in a separate directory to Firedrake's default location for G-ADOPT) you should first clone the GitHub repository from
[https://github.com/g-adopt/g-adopt](https://github.com/g-adopt/g-adopt):
If you are keen to make changes to the core G-ADOPT code (and you want to work in a separate directory to Firedrake's default location for G-ADOPT), you should first clone the [G-ADOPT GitHub repository](https://github.com/g-adopt/g-adopt):

git clone https://github.com/g-adopt/g-adopt.git

After activating the virtual environment of an existing Firedrake installation, you can then install G-ADOPT with:

pip install -e g-adopt/

The editable, -e, flag means that any updates you make to this directory will be reflected directly in the Firedrake virtual environment.
The editable, `-e`, flag means that any updates you make to this directory will be reflected directly in the Firedrake virtual environment.
4 changes: 2 additions & 2 deletions docs/publications.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Publications

## Citing G-ADOPT
## Citing G-ADOPT

If you publish results using G-ADOPT, we would be grateful if you would cite the software using the following metadata and the two articles below.
If you publish results using G-ADOPT, we would be grateful if you could cite the software using the following metadata and the two articles below.

??? abstract "G-ADOPT references (BibTeX)"
``` bibtex title="gadopt.bib"
Expand Down
Loading

0 comments on commit 42f4422

Please sign in to comment.