Skip to content

Commit

Permalink
Installation instructions with the GitHub repository
Browse files Browse the repository at this point in the history
Fixes #160
  • Loading branch information
ccarouge committed Nov 26, 2023
1 parent 8b2b8f6 commit 11a7cde
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ All documentation is located in the [CABLE GitHub repository][cable-repo]. To up
## Scientific documentation
The *scientific documentation* should be added directly into the source code available under the `src/` directory. Please use [these guidelines][api-guidelines] to structure the documentation. You can find a cheatsheet for FORD [on this page][cheat-sheets].

???+ warning "No code changes please"

Currently, the CABLE code under `src/` is only for documentation purposes. All code changes should go on the SVN repository. Any code change submitted in the GitHub repository will be discarded at this stage. Only changes to comments for documentation will be accepted.

## Other documentation
Other documentation such as the User guide and Developer guide are located under the `documentation/docs/` folder. Each file corresponds to a page on the rendered documentation and each folder corresponds to a tab or a section. Folders and files are named very similarly to the sections and pages on the documentation website to help navigation when developing the documentation.
To help you find the file corresponding to a page, on the rendered [documentation website][doc-pages], you can click on the pen icon :material-pencil: at the top right. This will open the corresponding file in GitHub and show you the path to the file. If you need more help to contribute to the User guide or the Developer guide, please use [the contribution guide for ACCESS-Hive][Hive-contribute].
Expand Down
5 changes: 0 additions & 5 deletions documentation/docs/developer_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ CABLE is a community model and, as such, we welcome contributions from anyone in

The CABLE code and documentation are hosted on GitHub. Guidelines are given here to use Git and GitHub for CABLE's work. If you are new to Git and GitHub, you might find it useful to follow a Git/GitHub tutorial in addition (e.g [The Carpentries training][sc-git]).

???+ Warning "Code changes are currently not accepted"

Although one can find the source code for CABLE in this repository, we do not accept any code changes
other than documentation at the moment. Please use the CABLE SVN repository for code modifications.

We recommend you [become a member][cable-lsm-join] of the CABLE-LSM GitHub organisation if you want to contribute to CABLE. This guide assumes you are a member of the organisation in its instructions.

We also ask that you become familiar with this developer guide. It contains important information on:
Expand Down
18 changes: 11 additions & 7 deletions documentation/docs/user_guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To install CABLE you need to have the following already installed on your system:

- SVN
- git
- a Fortran compiler
- the netCDF library

Expand All @@ -11,7 +11,7 @@ To install CABLE you need to have the following already installed on your system
``` mermaid
graph TD
A(Checkout CABLE with SVN):::UserAction -->|Serial?| B(Run `offline/build3.sh`):::UserAction;
A(Clone CABLE with git):::UserAction -->|Serial?| B(Run `offline/build3.sh`):::UserAction;
B --> D[load modules, set compiler flags, create .tmp/ directory];
D -->|Serial?| E[Run `serial_cable`];
E --> G[executable `cable`]:::Output;
Expand All @@ -38,9 +38,13 @@ graph TD

## Getting the CABLE source code

CABLE can be downloaded from the [subversion repository][cable-svn] hosted at [NCI][NCI] once a user has requested admission to the CABLE software group at NCI, as described [here][registration]. To install the latest version of CABLE, you simply need to checkout the `trunk`:
CABLE can be downloaded from the [GitHub repository][cable-github]. To install the latest version of CABLE, you simply need to clone the repository:

svn checkout https://trac.nci.org.au/svn/cable/trunk
git clone https://github.com/CABLE-LSM/CABLE.git

!!! tip "Choice of protocol"

If you have SSH keys installed for GitHub, you can also use the SSH protocol to clone the CABLE repository.

## Building CABLE

Expand Down Expand Up @@ -122,9 +126,9 @@ To clean the build, you need to run:

./build3.sh clean

[cable-svn]: https://trac.nci.org.au/svn/cable
[cable-github]: https://github.com/CABLE-LSM/cable.git
[NCI]: https://nci.org.au
[registration]: https://trac.nci.org.au/trac/cable/wiki/CABLE_Registration
[build3]: https://trac.nci.org.au/svn/cable/trunk/offline/build3.sh
[makefile]: https://trac.nci.org.au/svn/cable/trunk/offline/Makefile
[build3]: https://github.com/CABLE-LSM/CABLE/blob/main/src/offline/build3.sh
[makefile]: https://github.com/CABLE-LSM/CABLE/blob/main/src/offline/Makefile
[clean-build]: installation.md/#cleaning-the-build
8 changes: 4 additions & 4 deletions documentation/docs/user_guide/uber_quick_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Assuming you have computing resources on gadi@NCI, installing and running CABLE is as simple as:

1. Checkout the source code:
1. Clone the source code:

svn checkout https://trac.nci.org.au/svn/cable/trunk MyCABLE
cd MyCABLE/offline
git clone https://github.com/CABLE-LSM/CABLE.git
cd CABLE/offline

1. Build a serial version of CABLE

Expand All @@ -25,7 +25,7 @@ ACCESS-ESM1.5 uses a version of CABLE based on CABLE-2.3.4.

ACCESS-CM2 uses a version of CABLE that is closer to the HEAD of the trunk at the time of writing (December 2019).

For a more detailed discussion of CABLE offline please see the other sections of the [Cable's User Guide][userguide].
For a more detailed discussion of CABLE offline, please see the other sections of the [Cable's User Guide][userguide].

[fluxnet-tumba]: https://fluxnet.org/sites/siteinfo/AU-Tum
[userguide]: index.md

0 comments on commit 11a7cde

Please sign in to comment.