Software for modelling marine ecosystem including spatial and temporal dynamics.
Attention!
Atlantis is a living piece of software and the information here cn get out of date quickly. While the informaiton here faithfully reflects the state of the model when the paper mentioned below was created things have moved on since. If you would like to more please go to the Atlantis research page or Atlantis-Wiki
Due to licensing requirements, new users must register to access the code. If you want a copy of the Atlantis main code (which you will need to start using the model) you will need to email the developers to get access to the Atlantis-Wiki. If the link doesn't autoconnect to email for you please check if you have a pop-up blocker turned on in your browser. Alternatively, right click on the text "email to developers" and select the option "copy email".
Download manuscript (link to the published manuscript introducing the model will be available here)
This page contains an example of an operational Atlantis model with details of the parameter (input) files and model output files given. It also gives brief details and instructions on how to compile and run an Atlantis model on your computer. For more detailed explanation about the code, the parameters and how to run Atlantis you will need to download the Atlantis manual and useful Atlantis references from here.
Attention!
Due to licensing requirements, new users must register to access the code. If you want a copy of the Atlantis main code (which you will need to start using the model) you will need to email the developers to get access to the Atlantis-Wiki. If the link doesn't autoconnect to email for you please check if you have a pop-up blocker turned on in your browser. Alternatively, right click on the text "email to developers" and select the option "copy email".
When you send the email, please be sure that the email contains your name, affiliation and a quick line on why you are interested. This is important for us to provide you the best possible support - it will not affect access, which is free of charge regardless.
Once you register and gain access to the wiki you will need to sign the (free) licence agreement. From the Atlantis-Wiki page you can access all the information on the code repository, detailed instructions, and operational examples.
List of model updates
A list of major changes made in new code revisions can be found here and on the Atlantis-Wiki page.
- Example Operational Model
- Model Installation and Running
- Instructions for Different Operating Systems
The best way to learn about a model, including it's input (parameter) files and outputs, is through the illustration of an existing operational model. The most used model example is the South East Tasmania (SETas) Atlantis model. This model is divided into 9 polygons and has 5 water layers and one sediment layer. It has 35 functional groups: 10 are structured by age, 23 are biomass pools, and three are detritus. This model is also forced by outputs from a hydrodynamic model that represent the flows between boxes, also includes forcing of salinity, temperature, fish catches, and arsenic concentration.
Here we provide a brief description of all the input files required to run an Atlantis model. For more details see the Atlantis manual part 1 and part 2 or the Atlantis-wiki.
All the input files needed to run the SETas model under Atlantis and output files can be downloaded here.
- Functional_groups.csv A file containing information about the functional groups in the model.
- Geography.bgm The file defines the geography used in the Atlantis model to define the bathymetry of the model system.
- Run_settings.prm A file storing all the parameters defining the run setup (timestep, run and stop times, etc.).
- Physics.prm Physics parameters (coefficients) - apart from setting some flags (e.g. turning resuspension on/off), point-source scaling and quarterly eddy strength distribution these parameters are not typically changed.
- Forcings.prm A file that lays out the forcing file pathways for hydrodynamics, point sources, climate time series (precipitation, irradiance, temperature and salinity), historical catch, fuel prices, GDP and complex spatial zonation.
- Biology.prm File detailing all the ecological parameters, submodel selection, network connection definitions and quarterly distributions.
- Migration.csv A file containing information about the migrations in and out of the model domain.
- Fisheries.csv A file containing information about the fisheries in the model.
- Initial_condition.nc A NetCDF file where the initial conditions of the model are given, such as the initial biomass and size values for each functional group and age structure (access the plain text version here).
- assess.prm File detailing the sample design, sampling error structures and basic assessment model parameters.
- Harvest.prm File storing all the fisheries and management parameters and submodel definitions.
- econ.prm A file storing all the socio-economics parameters (for the market model, trading model, and black-book based effort allocation model).
- time_serie.ts Optional forcing and input files with data columns for a particlar reference year (e.g. fisheries catch or solar radiation data).
Initial distribution of one functional group
Here we provide a brief description of all the output files from an Atlantis model. For more details see the Atlantis manual (part 1 and part 2).
Atlantis generates a number of NetCDF output files that contain spatial information such as the biomass of functional groups in boxes and layers. The NetCDF files do not follow the normal gridded NetCDF structure that people are used to as the Atlantis model is a box model, not a grid model. The normal packages such as ncview will not work with Atlantis output NetCDF files. To read these outputs you can use your own code or one of the tools listed below.
- biol.nc Contains snapshots of the tracers in the model at given time frequencies in each box and layer.
- biolTOT.nc Contains a sum of the tracer values in each box and time-step.
- biolPROD.nc Useful during the model tuning process and contains 2D data (time, box) for each box. It also contains the tracers for production and grazing for invertebrate groups, growth and consumption for each age class for each vertebrate group, and a number of indices such as the diversity index.
- CATCH.nc Contains cumulative values of catch and discard per species and age class (cohort) in numbers. It also details catch and discards per species per fishery (in tonnes per box).
- TOTCATCH.nc This output files also contains cumulative total catch and discards per species in tonnes. All values are zeroed after they are written out.
- ANNAGEBIO.nc This output provides abundance in each annual age class (Numbers at age per species).
- ANNAGECATCH.nc Provides numbers at age per species in the catch and discards (summed over all fleets).
These files can contains a simplified or aggregate version of the information contained in the NetCDF files or and specific output.
- BiomIndx.txt Biomass in tonnes of each species across the entire model domain
- DietCheck.txt Indication of diet pressure
- DetailedDietCheck.txt This file is only produced if flagdietcheck is set to 1. The file produced provides the total biomass consumed of each prey species per age class of each predator species per box and layer.
- YOY.txt This is the biomass in tonnes per spawning event summed over the total model domain.
- BrokenStick.txt The output file that has been created to debug the broken stick management strategy.
- Catch.txt The total landings per species (in tonnes) across the entire model domain (summed over fisheries)
- CatchPerFishery.txt The catch of each species per fishery (in tonnes) across the entire model domain (summed over fisheries)
- Discards.txt The total discards per species across the entire model domain (summed over fisheries)
- DiscardsPerFishery.txt The discards of each species per fishery across the entire model domain (summed over fisheries)
There are various tools that help visualise Atlantis output files and many users write their own codes. These tools are listed below. Here we show a few example plots that can be produced with these tools.
Note: Refer to Functional_groups.csv for full names and descriptions of functional groups in the model.
To process and visualize inputs and output files of an Atlantis model, there exists a number of software. Below we describe some widely used examples.
-
Atlantistools: Is a data processing and visualization tool for R, which helps to process output from Atlantis models within R. Using atlantistools makes sure that Atlantis users use the same input/output file structure which facilitates intra and inter model comparisons.
-
ShinyRAtlantis: An r-based shiny package that can be used to visually assess parameter values and initial conditions of an Atlantis model.
-
ReactiveAtlantis: Reactive Atlantis has several tools that were created to help in the tuning, parametrization and analysis of the processes and parameters most often modified during the calibration of Atlantis. This tool was used to produce the figures above.
-
rbgm: Allows reading of geometry from BGM files, either in raw coordinate form or as Spatial objects.
-
angstroms: The goal of angstroms is to provide easy access to Regional Ocean Modeling System (ROMS) output for R.
Links to other software used can be accessed via the Atlantis-Wiki.
For detailed model installation and running instructions see chapter 2 in the Atlantis manual Part I. Here we briefly describe the main steps involved.
Atlantis is available for multiple operating systems. By using version control tools (such as SVN) the users are guaranteed to get the correct formatting (i.e. line endings) of the files for their operating system. Further, the version control tools allow users to check out specific versions of the code, which ensures better replicability of results (please always put the version of the code used in your publications). The tools also contain details about changes between versions, which makes code development more transparent, because all users can track the changes. Finally, as new updates and bug fixes are released the version control tools provide an easy way to update the code, because users don’t need to download the entire code but just update the libraries.
Atlantis is a complex modelling package that is based on a large number of processes, assumptions and equations. Appropriate and responsible use of such a package therefore requires users to have reasonable computational and basic coding skills. The Atlantis manual provides details on code libraries and routines for the processes included in Atlantis. This means that users can track down specific aspects of the code and make sure they are comfortable with the assumptions of the model. Developing and calibrating specific model applications is greatly enhanced if users can write their own print statements to understand behaviour of their specific system, e.g. recruits of a specific functional group in a particular model box. This means that the code has to be compiled locally after each print statement. Please note, that checking out, compiling and getting the example model to run on your computer will take about 1-2 hours. While this may seem long, the development of a new application to your system is likely to take months. If you consider that this timeframe is too long, it is advisable to consider a simpler modelling framework.
Atlantis can be run on Linux, Windows, and MacOS operating systems. Depending on your operating system Atlantis requires the a number of packages and libraries to be installed. This includes software that operates as:
- A compiler (e.g. Visal Studio for Windows or gcc for Linux).
- An SVN platform to check out the code (e.g. Tortoise SVN for Windows or subversion for Linux).
- A NetCDF file system or development library (e.g. NetCDF 4 for Windows).
Please read the instructions for your operating system for more details below.
Code:
Note: Remember that if you want a copy of the Atlantis main code you will need to go first to the Atlantis-Page and sign the licence agreement and then send an email to the developers, who will give you access to the code.
This page will be updated to include model inputs and outputs for the most recent version of the Atlantis code (currently version 6444). To get this specific version, please enter this line in your SVN platform
CSIRO users: svn co -r 6444 https://svnserv.csiro.au/svn/atlantis/Atlantis/trunk/atlantis
External Partners: svn co -r 6444 https://svnserv.csiro.au/svn/ext/atlantis/Atlantis/trunk/atlantis
To download the latest version code, the following URL link will need to be checked in by your SVN platform:
CSIRO users: https://svnserv.csiro.au/svn/atlantis/Atlantis/trunk/atlantis
External Partners: https://svnserv.csiro.au/svn/ext/atlantis/Atlantis/trunk/atlantis
To check the updates and changes in the code since the Atlantis publication, go to the Atlantis Updates page on the wiki.
Once you have your compiler, NetCDF reader and source code, it is time to build (upload and connect) your model files.
At this stage you should be able to run an operational model (such as that provided above), by calling a .sh or .bat file in the command line.
After starting the run, Atlantis will start loading input files and will likely give several warning messages. Most of these warning messages are produced to inform users about the spatial position of their functional groups, missing non-essential parameters and other model aspects that may require attention. It is advisable that users read these messages to make sure that there model is set up as intended. Where more concerning issues are present, the model will stop running. A possible reason for this occuring is when parameter files are out of date with the code in which case a missing parameter error message will be relayed. (e.g., Error: Unable to find species parameter _min_spawn_temp in file Biology.prm for group FPS). Please consult the Atlantis Updates for a lists major repository revisions and the updates to include in your input files.
- gcc - GNU Compiler Collection
- subversion - Used to check out the code from the code repository
- netcdf Development library
- libxml Development library
- proj Development library - used for GIS projections
- pkg-config Can get by without this but it will be easier if you have it
$ dpkg -l | grep build-essential # Essential packages to build Debian
$ dpkg -l | grep autoconf # Automatic configure script builder
$ dpkg -l | grep subversion # Version Control System (like GITHUB)
$ dpkg -l | grep gawk # GNU version of Awk
$ dpkg -l | grep proj # Program Proj.4 Cartographic projection
$ dpkg -l | grep libxml2-dev # Library for XML language
$ dpkg -l | grep libnetcdf-dev # Library of development kit for NetCDF
$ dpkg -l | grep flip # convert text file line endings between Unix and DOS
In the case that you do not have any of the libraries or packages of the previous point installed, this is the way to install them on your machine (using the terminal).
Ubuntu
$ sudo apt-get install build-essential
$ sudo apt-get install autoconf
$ sudo apt-get install subversion
$ sudo apt-get install libxml2-dev
$ sudo apt-get install libnetcdf-dev
$ sudo apt-get install gawk
proj4 install proj.4 following the instruction from developers webpage
Fedora
$ yum install netcdf-devel # Install the netcdf developer package
$ yum install subversion # Install Subversion
$ yum install proj-devel # Install the proj4 projection package
$ yum install libxml2-devel # Install the libxml developer package
$ yum install automake # Install automake
$ yum install pkgconfig # Install pkgconfig
Note: Most computers with other versions of Linux, follow similar instructions to install the necessary packages and libraries. If you have questions, visit Wiki-Packages-Linux
$ svn co https://svnserv.csiro.au/svn/ext/atlantis/Atlantis/trunk/atlantis
So far we have built Atlantis, for Linux, on the following platforms: Ubuntu, Fedora, CentOS, Debian 7.2, and Wheezy 64
We recommend 64-bit Ubuntu.
$ cd /to/your/atlantis/trunk/folder/
$ aclocal
$ autoconf
$ automake -a # If you have problems with this section
$ autoreconf -fvi # you can use this command instead
$ sudo chmod x configure # Change the permissions to the configure script
$ ./configure
$ make
$ sudo make install
To build Atlantis in another versions of Linux please visit the Wiki-Building-Linux.
Note: Before you can run the example Atlantis model under Linux you will need to convert the input files in Linux EOL format. On your terminal navigate to your Atlantis model folder and then convert the files:
$ cd ~\You\Atlantis\Model\Folder\
$ flip -uvt *.*
Create the bash application program file (.sh)
- Open your plain text editor, such as gedit, emacs or nano. (e.g. runAtlantis.sh)
- Add the commands to run Atlantis, which should have the following fortat:
If you're using Ubuntu:
#!/bin/bash atlantisMerged -i Initial_condition.nc 0 -o Test_output.nc -r Run_settings.prm -f Forcings.prm -p Physics.prm -b Biology.prm -h Harvest.prm -s Functional_groups.csv -q Fisheries.csv -d outputFoder - Open the terminal window, navigate to your model run
directory that has the .sh file in it (and your Atlantis model), type the name of your
.sh file and press ENTER.
user@pc:~$ user@pc:~$ cd Atlantis/run user@pc:~/Atlantis/run> ./runAtlantis.sh
- The compiler - any of the following versions of Visual Studio will the compiler Visual C
- Visual Studio C 2008
- Visual Studio C 2010
- Visual Studio C 2012
- Visual Studio C Express Edition
You can download all these versions here
Note: Atlantis will not compile using Visual Studio 2015
-
A NetCDF development library
Follow instructions to download NetCDF 4. For further information see the Atlantis-Wiki
-
An SVN platform to check out the source code from the code repository
Dowload TortoiseSVN as the preferred GUI.
Building in Visual Studio requires opening the appropriate visual studio solution in the root Atlantis SVN repository folder.
- Visual Studio 2008 uses atlantis_VS2008.sln
- Visual Studio 2010 uses atlantis_VS2010.sln
- Visual Studio 2012 uses atlantis_VS2012.sln
Step 1: In Visual Studio, right click on the atlantis solution and select ‘Rebuild all’. The build process should show all projects succeeding with 0 failings.
Step 2: The executable file atlantismain.exe should then be copy from the atlantismain/Debug folder to the folder where your model run files are kept.
For more details on the building process, including how to fix common errors, visit Wiki-Building-Windows.
To locally compile the code, create a new folder or checkout directory for your source code (e.g. c:\Code\atlantis). Right click in this new folder and select the new menu option "SVN checkout" and enter the appropriate URL of repository:
CSIRO users: https://svnserv.csiro.au/svn/atlantis/Atlantis/trunk/atlantis
External Partners: https://svnserv.csiro.au/svn/ext/atlantis/Atlantis/trunk/atlantis
You will then be asked to authenticate using your domain username and password provided after registering to be a user.
Create the batch file (.bat)
- Open your plain text editor (e.g. Textpad, Notepad or WordPad) and save (e.g. runAtlantis.bat)
- Add the commands to run Atlantis, which should have the following format:
atlantismain.exe -i Initial_condition.nc 0 -o Test_output.nc -r Run_settings.prm -f Forcings.prm -p Physics.prm -b Biology.prm -h Harvest.prm -s Functional_groups.csv -q Fisheries.csv -d outputFoder
Open the dos command prompt window, navigate to your model run directory that has the .bat files in it (and the .exe file if you have not formally installed Atlantis to the command line paths), type the name of your .bat file and press ENTER.
C:\> cd Atlantis\run
C:\Atlantis\run$ runAtlantis.bat
Note: An operational Atlantis model can be run on a Windows computer without a compiler, NetCDF library, or the code. Please contact the developers for more information about this option, if desired.
We would not recommend using Mac if you have a choice. It generally takes a couple of hours and as much as a day per machine to set up. Its not as simple as running on Windows or Linux and you will need to be comfortable installing libraries from source.
- Xcode: To install Xcode you might download a dgm file. Once this is downloaded open Finder and drag the Xcode folder into your applications to install it. Once its finished installing you need to eject it before you delete it from your downloads folder. Then you might need to type something like the following:
$ sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
- GCC : You should use gcc-7, prior to high sierra it was gcc-4.6. You can install this using macports or homebrew.
Atlantis needs the following libraries to be installed. For each library download the most recent stable versions.
- autoconf Automatic configure script builder. Download using macports.
- automake Automatic make script builder. Download using macports.
- Netcdf Development library.
- proj4 Development library, used for GIS projections. Make sure you get version 4.7.0.
- pkgconfig Helper tool used when compiling applications and libraries. Download using macports or from freedesktop.
- libxml - Library to deal with xml files format.
All of the following libraries should be downloaded to a folder such as /home/Downloads To install the library "libname" you should do :
- Unpacked using:
$ gzip -dv libname.tar.gz
$ tar -xvf libname.tar
- Then cd into the libname dir
$ cd libname
- Then configure the library and install
$ ./configure
$ make
$ sudo make install
Initially, to include all the source code you will need to build the code via command line rather than using other developer software (e.g. eclipse ). In the Atlantis code there is a file called configure_mac, you will probably need to edit this file to point to each of the locations of the libraries you have installed. In the following instructions substitute configure_N with the name of the custom configure_mac file you have created.
Open a terminal and go to where your source code is and type:
$ aclocal
$ autoheader
$ autoconf
$ automake -a
$ ./configure_N
make
This will hopefully build an executable called atlantisNew in the atlantismain folder. If it doesn't work you will probably need to edit the configure_N script you have created to point to the correct folders or check the libraries are correctly installed.
$ sudo make install
This will install the Atlantis header files and the executable in /usr/local/include/Atlantis-1.0/Atlantis and /usr/local/bin
More detailed information bout how to build Atlantis can be found in the Wiki-Building-MacOS.
Create the bash application program file (.sh)
-
Open your plain text editor, such as gedit, emacs or nano. (e.g. runAtlantis.sh)
-
Add the commands to run Atlantis, which should have the following fortat:
#!/bin/bash atlantisMerged -i Initial_condition.nc 0 -o Test_output.nc -r Run_settings.prm -f Forcings.prm -p Physics.prm -b Biology.prm -h Harvest.prm -s Functional_groups.csv -q Fisheries.csv -d outputFoder
Open the terminal window, navigate to your model run directory that has the .sh file in it (and your Atlantis model), type the name of your .sh file and press ENTER.
user@pc:~$
user@pc:~$ cd Atlantis/run
user@pc:~/Atlantis/run> ./runAtlantis.sh