Skip to content

Commit 4ab7c1c

Browse files
Fix doc links (#28)
* Fix links in the docs and the README. * Add version and authors to Project.toml
1 parent 35d7501 commit 4ab7c1c

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

Project.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
name = "Mocca"
22
uuid = "eb14e3ba-90c8-11ed-0ecf-1dd2ea0d109c"
3+
version = "0.0.1"
4+
authors = ["Francesca Watson <francesca.watson@sintef.no>"]
35

46
[deps]
57
CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
[Mocca.jl](https://github.com/sintefmath/Mocca.jl) provides a [Julia](https://julialang.org/) based framework for the simulating pressure / temperature swing adsorption processes for CO2 capture.
77

8-
To learn more about using Mocca please see the [documentation] (https://sintefmath.github.io/Mocca.jl/dev/).
8+
To learn more about using Mocca please see the [documentation](https://sintefmath.github.io/Mocca.jl/dev/).
99

1010
Currently there is an implementation of a 4-stage vacuum swing adsorption process for CO2 capture, from a two-component flue gas, using Zeolite 13X and a dual-site Langmuir model. See [Direct Column Breakthrough simulation](https://github.com/sintefmath/Mocca.jl/blob/main/examples/simulate_DCB.jl) and [Cyclic Vacuum Swing Adsorption simulation](https://github.com/sintefmath/Mocca.jl/blob/main/examples/simulate_cyclic.jl). Additionally, we have made examples demonstrating capabilities for doing [Optimization](https://github.com/sintefmath/Mocca.jl/blob/main/examples/optimization.jl) and [History matching](https://github.com/sintefmath/Mocca.jl/blob/main/examples/history_matching.jl) in Mocca.jl.
1111

@@ -28,7 +28,7 @@ Pkg.instantiate()
2828

2929
This will activate the environment in the current directory and install all necessary dependencies. Mocca is now installed and ready to use.
3030

31-
To get started try the [quick start]((https://github.com/sintefmath/Mocca.jl/blob/main/examples/quick_start.jl) example.) or [Direct Column Breakthrough simulation](https://github.com/sintefmath/Mocca.jl/blob/main/examples/simulate_DCB.jl) example. examples. Bear in mind that the first time you run the code in the Julia REPL it may take several minutes to run as Julia needs to compile all the necessary code. As long as you do not close the REPL, the second time you run the code will be much quicker!
31+
To get started try the [quick start](https://github.com/sintefmath/Mocca.jl/blob/main/examples/quick_start.jl) or [Direct Column Breakthrough simulation](https://github.com/sintefmath/Mocca.jl/blob/main/examples/simulate_DCB.jl) examples. Bear in mind that the first time you run the code in the Julia REPL it may take several minutes to run as Julia needs to compile all the necessary code. As long as you do not close the REPL, the second time you run the code will be much quicker!
3232

3333

3434
# Quick start example
@@ -37,7 +37,7 @@ Direct Column breakthrough adsorption simulation using predefined input paramete
3737

3838
The example uses some utility functions which simplify the simulation setup.
3939
To see the steps used in more detail, please refer to the
40-
[Simulate DCB](simulate_DCB.md) example.
40+
[Simulate DCB](https://github.com/sintefmath/Mocca.jl/blob/main/examples/simulate_DCB.jl) example.
4141

4242
```julia
4343
using Mocca

docs/src/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ Pkg.instantiate()
2323

2424
This will activate the environment in the current directory and install all necessary dependencies. Mocca is now installed and ready to use.
2525

26-
A good starting example to try is [Direct Column Breakthrough simulation](https://github.com/sintefmath/Mocca.jl/blob/main/examples/simulate_DCB.jl). Bear in mind that the first time you run the code in the Julia REPL it may take several minutes to run as Julia needs to compile all the necessary code. As long as you do not close the REPL, the second time you run the code will be much quicker!
26+
A good starting example to try is [Direct Column Breakthrough simulation](simulate_DCB.md). Bear in mind that the first time you run the code in the Julia REPL it may take several minutes to run as Julia needs to compile all the necessary code. As long as you do not close the REPL, the second time you run the code will be much quicker!

docs/src/quick_start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Direct Column breakthrough adsorption simulation using predefined input paramete
88

99
The example uses some utility functions which simplify the simulation setup.
1010
To see the steps used in more detail, please refer to the
11-
[Direct Column Breakthrough simulation](https://github.com/sintefmath/Mocca.jl/blob/main/examples/simulate_DCB.jl) example.
11+
[Direct Column Breakthrough simulation](simulate_DCB.md) example.
1212

1313
```julia
1414
using Mocca

0 commit comments

Comments
 (0)