Skip to content

Commit fe36bea

Browse files
authored
Merge pull request #4 from AnStroh/pa-rename
Name change according to guidelines
2 parents 3e15bcc + 03dce52 commit fe36bea

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+87
-74
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ Manifest.toml
22
.DS_Store
33
*.pdf
44
*.png
5+
settings.json

AUTHORS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Authors
22

3-
[MOBILE.jl](https://github.com/AnStroh/MOBILE.jl)'s development is coordinated by a group of *principal developers*,
3+
[MovingBoundaryMinerals.jl](https://github.com/AnStroh/MovingBoundaryMinerals.jl)'s development is coordinated by a group of *principal developers*,
44
who are also its main contributors and who can be contacted in case of
5-
questions about [MOBILE.jl](https://github.com/AnStroh/MOBILE.jl). In addition, there are *contributors* who have
5+
questions about [MovingBoundaryMinerals.jl](https://github.com/AnStroh/MovingBoundaryMinerals.jl). In addition, there are *contributors* who have
66
provided substantial additions or modifications. Together, these two groups form
7-
"MOBILE.jl.jl Authors".
7+
"MovingBoundaryMinerals.jl.jl Authors".
88

99
## Principal Developers
1010
* [Annalena Stroh](https://github.com/AnStroh),
@@ -14,7 +14,7 @@ provided substantial additions or modifications. Together, these two groups form
1414

1515

1616
## Contributors
17-
The following people contributed major additions or modifications to [MOBILE.jl](https://github.com/AnStroh/MOBILE.jl) and
17+
The following people contributed major additions or modifications to [MovingBoundaryMinerals.jl](https://github.com/AnStroh/MovingBoundaryMinerals.jl) and
1818
are listed in alphabetical order:
1919

2020
* [Pascal Aellig](https://github.com/aelligp),

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Contributing
22

3-
[MOBILE.jl](https://github.com/AnStroh/MOBILE.jl) is an open-source project and we are very happy to accept contributions
4-
from the community. Please feel free to [open issues](https://github.com/AnStroh/MOBILE.jl/issues/new) or submit patches (preferably
5-
as [pull requests](https://github.com/AnStroh/MOBILE.jl/pulls)) any time. For planned larger contributions, it is often
3+
[MovingBoundaryMinerals.jl](https://github.com/AnStroh/MovingBoundaryMinerals.jl) is an open-source project and we are very happy to accept contributions
4+
from the community. Please feel free to [open issues](https://github.com/AnStroh/MovingBoundaryMinerals.jl/issues/new) or submit patches (preferably
5+
as [pull requests](https://github.com/AnStroh/MovingBoundaryMinerals.jl/pulls)) any time. For planned larger contributions, it is often
66
beneficial to get in contact with one of the principal developers first (see
77
[AUTHORS.md](AUTHORS.md)).
88

9-
[MOBILE.jl](https://github.com/AnStroh/MOBILE.jl) and its contributions are licensed under the MIT license. As a contributor, you certify that all your
9+
[MovingBoundaryMinerals.jl](https://github.com/AnStroh/MovingBoundaryMinerals.jl) and its contributions are licensed under the MIT license. As a contributor, you certify that all your
1010
contributions are in conformance with the *Developer Certificate of Origin
1111
(Version 1.1)*, which is reproduced below.
1212

Project.toml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
name = "MOBILE"
1+
name = "MovingBoundaryMinerals"
22
uuid = "ede1ac2d-c776-4409-bf2f-c421e41a2d87"
33
authors = ["Annalena Stroh <anstroh@uni-mainz.de>, Evangelos Moulas <evmoulas@uni-mainz.de>, Pascal Aellig <paellig@uni-mainz.de>"]
44
version = "0.1.0"
55

66
[deps]
77
CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
8-
ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
98
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
109
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
1110
DelimitedFiles = "8bb1440f-4735-579b-a4ab-409b98df4dab"
@@ -20,4 +19,17 @@ SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
2019
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
2120

2221
[compat]
22+
CSV = "0.10"
23+
DataFrames = "1.7"
24+
Dates = "1.10, 1.11"
25+
DelimitedFiles = "1.9"
26+
FileIO = "1"
27+
ImageIO = "0.6"
28+
Interpolations = "0.16"
29+
LaTeXStrings = "1.4"
30+
Plots = "1.40"
31+
SparseArrays = "1.10, 1.11"
32+
LinearAlgebra = "1.10, 1.11"
33+
SpecialFunctions = "2.5"
34+
Statistics = "1.10, 1.11"
2335
julia = "1.10, 1.11"

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://anstroh.github.io/MOBILE.jl/dev/)
2-
[![CI](https://github.com/AnStroh/MOBILE.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/AnStroh/MOBILE.jl.jl/actions/workflows/CI.yml)
1+
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://anstroh.github.io/MovingBoundaryMinerals.jl/dev/)
2+
[![CI](https://github.com/AnStroh/MovingBoundaryMinerals.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/AnStroh/MovingBoundaryMinerals.jl/actions/workflows/CI.yml)
33
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
44
# MovingBoundaryMinerals.jl
5+
56
MovingBoundaryMinerals.jl is a software to model diffusion-controlled growth/resorption processes in mineral couples.
67
We tested our software with various analytical and semi-analytical solutions (examples A1-A2, B1-B5, C1). In addition, we present some mineral growth/resorption examples (B6-B7, C2, D1) showing compositional profiles, which can be observed in natural samples.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ used in the Julia ecosystem is supported with security updates.
1515
## Reporting a Vulnerability
1616

1717
To report a security issue, please use the GitHub Security Advisory
18-
["Report a Vulnerability"](https://github.com/AnStroh/MOBILE.jl/security/new)
18+
["Report a Vulnerability"](https://github.com/AnStroh/MovingBoundaryMinerals.jl/security/new)
1919
tab.
2020

2121
We will send a response indicating the next steps in handling your report.

docs/Project.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3-
MOBILE = "ede1ac2d-c776-4409-bf2f-c421e41a2d87"
3+
MovingBoundaryMinerals = "ede1ac2d-c776-4409-bf2f-c421e41a2d87"
44

55
[sources]
6-
MOBILE = {path = ".."}
6+
MovingBoundaryMinerals = {path = ".."}
77

88
[compat]
99
Documenter = "1"

docs/make.jl

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
using Documenter
2-
using MOBILE
2+
using MovingBoundaryMinerals
33

4-
# Get MOBILE.jl root directory
4+
# Get MovingBoundaryMinerals.jl root directory
55
DC_root_dir = dirname(@__DIR__)
66

77
license = read(joinpath(DC_root_dir, "LICENSE.md"), String)
@@ -22,7 +22,7 @@ open(joinpath(@__DIR__, "src", "man", "license.md"), "w") do io
2222
# Point to source license file
2323
println(io, """
2424
```@meta
25-
EditURL = "https://github.com/AnStroh/MOBILE.jl/blob/main/LICENSE.md"
25+
EditURL = "https://github.com/AnStroh/MovingBoundaryMinerals.jl/blob/main/LICENSE.md"
2626
```
2727
""")
2828
# Write the modified contents
@@ -38,7 +38,7 @@ open(joinpath(@__DIR__, "src", "man", "code_of_conduct.md"), "w") do io
3838
# Point to source license file
3939
println(io, """
4040
```@meta
41-
EditURL = "https://github.com/AnStroh/MOBILE.jl/blob/main/CODE_OF_CONDUCT.md"
41+
EditURL = "https://github.com/AnStroh/MovingBoundaryMinerals.jl/blob/main/CODE_OF_CONDUCT.md"
4242
```
4343
""")
4444
# Write the modified contents
@@ -54,7 +54,7 @@ open(joinpath(@__DIR__, "src", "man", "contributing.md"), "w") do io
5454
# Point to source license file
5555
println(io, """
5656
```@meta
57-
EditURL = "https://github.com/AnStroh/MOBILE.jl/blob/main/CONTRIBUTING.md"
57+
EditURL = "https://github.com/AnStroh/MovingBoundaryMinerals.jl/blob/main/CONTRIBUTING.md"
5858
```
5959
""")
6060
# Write the modified contents
@@ -66,9 +66,9 @@ open(joinpath(@__DIR__, "src", "man", "contributing.md"), "w") do io
6666
end
6767
@info "Making documentation..."
6868
makedocs(;
69-
sitename="MOBILE.jl",
69+
sitename="MovingBoundaryMinerals.jl",
7070
authors="Annalena Stroh, Evangelos Moulas and contributors",
71-
modules=[MOBILE],
71+
modules=[MovingBoundaryMinerals],
7272
format=Documenter.HTML(; assets = ["assets/favicon.ico"],
7373
prettyurls=get(ENV, "CI", nothing) == "true",
7474
size_threshold_ignore = ["man/listfunctions.md"]), # easier local build
@@ -89,9 +89,9 @@ makedocs(;
8989
],
9090
)
9191

92-
withenv("GITHUB_REPOSITORY" => "AnStroh/MOBILE.jl") do
92+
withenv("GITHUB_REPOSITORY" => "AnStroh/MovingBoundaryMinerals.jl") do
9393
deploydocs(
94-
repo = "github.com/AnStroh/MOBILE.jl",
94+
repo = "github.com/AnStroh/MovingBoundaryMinerals.jl",
9595
devbranch = "main",
9696
push_preview = true
9797
)

docs/src/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
```@meta
2-
CurrentModule = MOBILE
3-
```# MOBILE.jl
2+
CurrentModule = MovingBoundaryMinerals
3+
```# MovingBoundaryMinerals.jl
44
55
This is the documentation page of the package Diffusion coupled growth.
66
# Installation
77
8-
[MOBILE.jl](https://github.com/AnStroh/MOBILE.jl) is not yet registered and can be added as follows:
8+
[MovingBoundaryMinerals.jl](https://github.com/AnStroh/MovingBoundaryMinerals.jl) is not yet registered and can be added as follows:
99
1010
```julia
11-
using Pkg; Pkg.add("https://github.com/AnStroh/MOBILE.jl.git")
11+
using Pkg; Pkg.add("https://github.com/AnStroh/MovingBoundaryMinerals.jl.git")
1212
```
1313
or
1414
```julia-repl
1515
julia> ]
1616
17-
(@v1.10) pkg> add https://github.com/AnStroh/MOBILE.jl.git
17+
(@v1.10) pkg> add https://github.com/AnStroh/MovingBoundaryMinerals.jl.git
1818
```
1919

2020
!!! info "Install from a specific branch"
2121
However, as the API is changing and not every new feature leads to a new release, one can also clone the main branch of the repository:
2222
```julia
23-
add https://github.com/AnStroh/MOBILE.jl.git#main
23+
add https://github.com/AnStroh/MovingBoundaryMinerals.jl.git#main
2424
```
2525

2626
After installation, you can test the package by running the following commands:
2727
```julia-repl
28-
using MOBILE
28+
using MovingBoundaryMinerals
2929
3030
julia> ]
3131
32-
(@v1.10) pkg> test MOBILE
32+
(@v1.10) pkg> test MovingBoundaryMinerals
3333
```

docs/src/man/general_remarks.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# General remarks
22

3-
In this section we would like to make a few generally useful comments on the structure of the codes.
3+
In this section we would like to make a few generally useful comments on the structure of the codes.
44

55
## Structure
66
We have tried to structure the individual files as uniformly as possible and to delete unnecessary parameters in the examples so that the user gets a good overview as quickly as possible and understands the individual examples well. Furthermore, the code works with SI units. Subsequently, users are asked to adjust their values or to change the units consequently at their own risk.Most of the codes are created to handle diffusion couples. In these codes we always refer to the left (phase A) and right side (phase B). If two numbers are stored in a variable, the first refers to the left material and the second to the right material. We have also stored generally valid codes in the main_codes folder. The examples can be found in the examples folder. Parameters in the main_codes folder have no physical meaning and act as placeholders such that the code works out of the box. In contrast, the examples show codes with real or non-dimensional values.
77

88
## Compositions and concentrations
9-
In our Julia package MOBILE.jl, we specify the concentration in mol. However, since we include any swelling or shrinking processes due to density differences, the composition can also be given in wt% or mol%. The respective parameters such as activation energy or densities must be corrected according to the utilized units. We want to emphasize, that consistence is extremely important here. The units of concentrations (e.g., mol) or compositions (e.g., wt%) are shortened at the end in the diffusion equation (Eq. 1). For more details: Appendices A and B in the related paper to this package (ADD REFERENCE!!!)
9+
In our Julia package MovingBoundaryMinerals.jl, we specify the concentration in mol. However, since we include any swelling or shrinking processes due to density differences, the composition can also be given in wt% or mol%. The respective parameters such as activation energy or densities must be corrected according to the utilized units. We want to emphasize, that consistence is extremely important here. The units of concentrations (e.g., mol) or compositions (e.g., wt%) are shortened at the end in the diffusion equation (Eq. 1). For more details: Appendices A and B in the related paper to this package (ADD REFERENCE!!!)
1010

1111
## Temperature and distribution coefficient
12-
In general, it is always possible to specify the temporal evolution of the distribution coefficient (KD) and the temperature as vectors. This makes it very easy to handle isothermal as well as non-isothermal problems and deal with constant or changing K_D values. Within the temperature and the KD vector, the first value defines the initial value. The last value defines value at the end of the simulation. If the first and the last entry are the same, the respective parameter is constant.
12+
In general, it is always possible to specify the temporal evolution of the distribution coefficient (KD) and the temperature as vectors. This makes it very easy to handle isothermal as well as non-isothermal problems and deal with constant or changing K_D values. Within the temperature and the KD vector, the first value defines the initial value. The last value defines value at the end of the simulation. If the first and the last entry are the same, the respective parameter is constant.
1313

1414
## Inner and outer boundaries
15-
The inner boundary at the interface can either be described by the flux balance approach or with total mass balance. Outer boundary conditions at the edges of the modeling domain can be set to Dirichlet or Neumann conditions using BCout.
15+
The inner boundary at the interface can either be described by the flux balance approach or with total mass balance. Outer boundary conditions at the edges of the modeling domain can be set to Dirichlet or Neumann conditions using BCout.
1616

1717
## Calculation of the diffusion coefficient
1818
There are two methods for calculating the diffusion coefficient in our package a) a constant diffusion coefficient is used by recording the respective values for the left and right side under the variable Di and b) if both values in Di are replaced with -1.0, D is calculated using the Arrhenius relationship. The same also applies to diffsion processes in single crystals. However, there is one exception. Within Chemical_Stefan_problem.jl, the diffusivities are implemented as constant values. Within example D1, we specify the diffusion coefficient for Fe-Mg in olivine and in the melt based on experimental values (Dohmen and Chakraborty, 2007a, b; Zhang and Cherniak, 2010) and effective evaluations (Crank, 1975). The user can customize the calculation method of the diffusion coefficients at any time.
@@ -22,4 +22,3 @@ Crank, J.: The mathematics of diffusion, 2d ed., Clarendon Press, Oxford, [Eng],
2222
Dohmen, R. and Chakraborty, S.: Fe–Mg diffusion in olivine II: point defect chemistry, change of diffusion mechanisms and a model for calculation of diffusion coefficients in natural olivine, Phys. Chem. Miner., 34, 597–598, https://doi.org/10.1007/s00269-007-0185-3, 2007a.
2323
Dohmen, R. and Chakraborty, S.: Fe–Mg diffusion in olivine II: point defect chemistry, change of diffusion mechanisms and a model for calculation of diffusion coefficients in natural olivine, Phys. Chem. Miner., 34, 409–430, https://doi.org/10.1007/s00269-007-0158-6, 2007b.
2424
Zhang, Y. and Cherniak, D. J.: Diffusion in Minerals and Melts: Introduction, Rev. Mineral. Geochem., 72, 1–4, https://doi.org/10.2138/rmg.2010.72.1, 2010.
25-

0 commit comments

Comments
 (0)