From 6aa7c820f63c3b4efc67b41bc031b4f60c0cca26 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Thu, 17 Oct 2024 09:18:16 +0000 Subject: [PATCH] build based on 46cd86c --- dev/.documenter-siteinfo.json | 2 +- dev/index.html | 2 +- dev/manual/index.html | 2 +- dev/manual_folder-structure/index.html | 2 +- dev/manual_get-started/index.html | 2 +- dev/manual_installation/index.html | 2 +- dev/troubleshooting/index.html | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index d2d6d7f..3fe4926 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2024-10-17T08:20:04","documenter_version":"1.4.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2024-10-17T09:18:13","documenter_version":"1.4.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 6110d84..de72b1f 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · AURORA.jl
GitHub
+Home · AURORA.jl
GitHub
diff --git a/dev/manual/index.html b/dev/manual/index.html index 7de9946..4b566c2 100644 --- a/dev/manual/index.html +++ b/dev/manual/index.html @@ -21,4 +21,4 @@ └── main.jl └── cascading.jl └── setup.jl - └── ...

The folder data/ contains the subfolders where simulation results are saved.

The folder docs/ contains all the necessary scripts to power this documentation.

The folder e_cascading_data/ is where the cascading data produced by the simulations are saved for future use by the program itself. The cascading data are saved by species in the subfolders N2/, O2/ and O/. You should not need to venture into this folder.

The folder scripts/ contains the scripts for the user to start the simulations and plot some of the results.

The folder src/ contains the source code of the model.

Get started

Simulations are started using the function calculate_e_transport(...). The function takes in many parameters, so it can be easier to use the script named Control_script.jl situated in the scripts/ folder. The script is pre-filled and you just need to modify the values of the parameters. You can also use the script as a template to make your own control scripts.

After you have modified the Control_script.jl and saved it, you just have to execute it. This can be done from the Julia REPL or from the command line.

Starting simulation from the Julia REPL

Activating the AURORA environment

To be able to use AURORA.jl, the repository environment needs to be activated. This can be done for example by starting Julia from the AURORA.jl/ folder using the command

$> julia --project=.

Or by entering the Pkg REPL using the ] key and typing

pkg> activate .
Using VS Code

If you are using VS Code with the Julia extension, the local environment should be automatically activated when you open the AURORA.jl/ folder.

Once the AURORA.jl environment activated, you can start simulations from the Julia REPL with the command

julia> include("scripts/Control_script.jl")

If you are using VS Code, you can also use the "Execute active File in REPL" button.

The results will be saved in a folder under data/ along with the parameters used to run the simulation.

Starting simulation from the command line

Move to the AURORA.jl/ folder. Then, execute the Control_script.jl using the command 

$> julia --project=@. scripts/Control_script.jl

The results will be saved in a folder under data/ along with the parameters used to run the simulation.

+ └── ...

The folder data/ contains the subfolders where simulation results are saved.

The folder docs/ contains all the necessary scripts to power this documentation.

The folder e_cascading_data/ is where the cascading data produced by the simulations are saved for future use by the program itself. The cascading data are saved by species in the subfolders N2/, O2/ and O/. You should not need to venture into this folder.

The folder scripts/ contains the scripts for the user to start the simulations and plot some of the results.

The folder src/ contains the source code of the model.

Get started

Simulations are started using the function calculate_e_transport(...). The function takes in many parameters, so it can be easier to use the script named Control_script.jl situated in the scripts/ folder. The script is pre-filled and you just need to modify the values of the parameters. You can also use the script as a template to make your own control scripts.

After you have modified the Control_script.jl and saved it, you just have to execute it. This can be done from the Julia REPL or from the command line.

Starting simulation from the Julia REPL

Activating the AURORA environment

To be able to use AURORA.jl, the repository environment needs to be activated. This can be done for example by starting Julia from the AURORA.jl/ folder using the command

$> julia --project=.

Or by entering the Pkg REPL using the ] key and typing

pkg> activate .
Using VS Code

If you are using VS Code with the Julia extension, the local environment should be automatically activated when you open the AURORA.jl/ folder.

Once the AURORA.jl environment activated, you can start simulations from the Julia REPL with the command

julia> include("scripts/Control_script.jl")

If you are using VS Code, you can also use the "Execute active File in REPL" button.

The results will be saved in a folder under data/ along with the parameters used to run the simulation.

Starting simulation from the command line

Move to the AURORA.jl/ folder. Then, execute the Control_script.jl using the command 

$> julia --project=@. scripts/Control_script.jl

The results will be saved in a folder under data/ along with the parameters used to run the simulation.

diff --git a/dev/manual_folder-structure/index.html b/dev/manual_folder-structure/index.html index c99475f..579a1f6 100644 --- a/dev/manual_folder-structure/index.html +++ b/dev/manual_folder-structure/index.html @@ -19,4 +19,4 @@ └── main.jl └── cascading.jl └── setup.jl - └── ...

The folder data/ contains the subfolders where simulation results are saved.

The folder docs/ contains all the necessary scripts to power this documentation.

The folder e_cascading_data/ is where the cascading data produced by the simulations are saved for future use by the program itself. The cascading data are saved by species in the subfolders N2/, O2/ and O/. You should not need to venture into this folder.

The folder scripts/ contains the scripts for the user to start the simulations and plot some of the results.

The folder src/ contains the source code of the model.

+ └── ...

The folder data/ contains the subfolders where simulation results are saved.

The folder docs/ contains all the necessary scripts to power this documentation.

The folder e_cascading_data/ is where the cascading data produced by the simulations are saved for future use by the program itself. The cascading data are saved by species in the subfolders N2/, O2/ and O/. You should not need to venture into this folder.

The folder scripts/ contains the scripts for the user to start the simulations and plot some of the results.

The folder src/ contains the source code of the model.

diff --git a/dev/manual_get-started/index.html b/dev/manual_get-started/index.html index 2340465..787b651 100644 --- a/dev/manual_get-started/index.html +++ b/dev/manual_get-started/index.html @@ -1,2 +1,2 @@ -Get started · AURORA.jl
GitHub

Get started

Simulations are started using the function calculate_e_transport(...). The function takes in many parameters, so it can be easier to use the script named Control_script.jl situated in the scripts/ folder. The script is pre-filled and you just need to modify the values of the parameters. You can also use the script as a template to make your own control scripts.

After you have modified the Control_script.jl and saved it, you just have to execute it. This can be done from the Julia REPL or from the command line.

Starting simulation from the Julia REPL

Activating the AURORA environment

To be able to use AURORA.jl, the repository environment needs to be activated. This can be done for example by starting Julia from the AURORA.jl/ folder using the command

$> julia --project=.

Or by entering the Pkg REPL using the ] key and typing

pkg> activate .
Using VS Code

If you are using VS Code with the Julia extension, the local environment should be automatically activated when you open the AURORA.jl/ folder.

Once the AURORA.jl environment activated, you can start simulations from the Julia REPL with the command

julia> include("scripts/Control_script.jl")

If you are using VS Code, you can also use the "Execute active File in REPL" button.

The results will be saved in a folder under data/ along with the parameters used to run the simulation.

Starting simulation from the command line

Move to the AURORA.jl/ folder. Then, execute the Control_script.jl using the command 

$> julia --project=@. scripts/Control_script.jl

The results will be saved in a folder under data/ along with the parameters used to run the simulation.

+Get started · AURORA.jl
GitHub

Get started

Simulations are started using the function calculate_e_transport(...). The function takes in many parameters, so it can be easier to use the script named Control_script.jl situated in the scripts/ folder. The script is pre-filled and you just need to modify the values of the parameters. You can also use the script as a template to make your own control scripts.

After you have modified the Control_script.jl and saved it, you just have to execute it. This can be done from the Julia REPL or from the command line.

Starting simulation from the Julia REPL

Activating the AURORA environment

To be able to use AURORA.jl, the repository environment needs to be activated. This can be done for example by starting Julia from the AURORA.jl/ folder using the command

$> julia --project=.

Or by entering the Pkg REPL using the ] key and typing

pkg> activate .
Using VS Code

If you are using VS Code with the Julia extension, the local environment should be automatically activated when you open the AURORA.jl/ folder.

Once the AURORA.jl environment activated, you can start simulations from the Julia REPL with the command

julia> include("scripts/Control_script.jl")

If you are using VS Code, you can also use the "Execute active File in REPL" button.

The results will be saved in a folder under data/ along with the parameters used to run the simulation.

Starting simulation from the command line

Move to the AURORA.jl/ folder. Then, execute the Control_script.jl using the command 

$> julia --project=@. scripts/Control_script.jl

The results will be saved in a folder under data/ along with the parameters used to run the simulation.

diff --git a/dev/manual_installation/index.html b/dev/manual_installation/index.html index 21ff6f0..396a876 100644 --- a/dev/manual_installation/index.html +++ b/dev/manual_installation/index.html @@ -1,4 +1,4 @@ Installation · AURORA.jl
GitHub

Installation

  1. Clone the repository (e.g. with Git) or download and extract the .zip (available under the green code button on the GitHub page)

  2. Open a terminal, move into the AURORA.jl, and start Julia with the command

$> julia
  1. Then, activate the repository and install the packages required by AURORA.jl using the commands
julia> using Pkg
 julia> Pkg.activate(".")
-julia> Pkg.instantiate() # this might take a while...
  1. AURORA.jl is now ready to use!
+julia> Pkg.instantiate() # this might take a while...
  1. AURORA.jl is now ready to use!
diff --git a/dev/troubleshooting/index.html b/dev/troubleshooting/index.html index 2dfe9e2..8d0ef24 100644 --- a/dev/troubleshooting/index.html +++ b/dev/troubleshooting/index.html @@ -1,2 +1,2 @@ -Troubleshooting · AURORA.jl
GitHub

Troubleshooting

Segmentation fault

If you get a segmentation fault when the code is calling Matlab (when the cross-section are being loaded), you want to check what version of Matlab is being called by Julia. By default, the package MATLAB.jl which is taking care of calling Matlab is using the Matlab installation with highest version number installed on your machine.

The problem is that some of the newer version of Matlab don't work well with the package MATLAB.jl and cause segmentation fault when being called. If that is the case, you need to switch back to a Matlab version with a version number older than R2022a. To do this, you can follow the steps at https://github.com/JuliaInterop/MATLAB.jl?tab=readme-ov-file#changing-matlab-version.

Don't forget to login and activate your Matlab license on that older version before trying to call it from Julia.

+Troubleshooting · AURORA.jl
GitHub

Troubleshooting

Segmentation fault

If you get a segmentation fault when the code is calling Matlab (when the cross-section are being loaded), you want to check what version of Matlab is being called by Julia. By default, the package MATLAB.jl which is taking care of calling Matlab is using the Matlab installation with highest version number installed on your machine.

The problem is that some of the newer version of Matlab don't work well with the package MATLAB.jl and cause segmentation fault when being called. If that is the case, you need to switch back to a Matlab version with a version number older than R2022a. To do this, you can follow the steps at https://github.com/JuliaInterop/MATLAB.jl?tab=readme-ov-file#changing-matlab-version.

Don't forget to login and activate your Matlab license on that older version before trying to call it from Julia.