Skip to content

Commit 469d842

Browse files
authored
Bump version to 4.0.0 (#244)
* Bump version to 4.0.0 * Update README.md * Remove release-candidate warning
1 parent a57d2af commit 469d842

21 files changed

Lines changed: 42 additions & 49 deletions

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
## Build Status
1+
# SimPhoNy documentation
22

3-
**latest** - [![Documentation latest](https://readthedocs.org/projects/simphony/badge/?version=latest)](https://simphony.readthedocs.io/en/latest/?badge=latest)
4-
**dev** - [![Documentation dev](https://readthedocs.org/projects/simphony/badge/?version=dev)](https://simphony.readthedocs.io/en/latest/?badge=dev)
3+
To access the documentation, please visit:
4+
[https://simphony.readthedocs.io](https://simphony.readthedocs.io/en/v4.0.0/).
55

6-
# SimPhoNy docs
6+
If you find any error or problem with the documentation,
7+
please [create an issue](https://github.com/simphony/docs/issues).
78

8-
To access the documentation, please visit: [https://simphony.readthedocs.io](https://simphony.readthedocs.io).
9-
10-
If you find any error or problem with the documentation, please [create an issue](https://github.com/simphony/docs/issues).
11-
12-
## Local Rendering
9+
## Local rendering
1310

1411
### HTML
1512

16-
A server will start, generate the docs and listen for changes in the source files.
17-
This can be done by using docker or installing the development environment directly on the you machine. Next are installation guides for Docker and Linux OS.
13+
Start a server, generate the docs and listen for changes in the source files.
14+
This can be done by using docker or installing the development environment
15+
directly on your machine. Next are installation guides for Docker and Linux.
1816

1917
#### Docker
2018

@@ -59,7 +57,8 @@ The documentation will be available on
5957

6058
### PDF (LaTeX)
6159

62-
To generate a PDF of the documentation, simply run (from the root project folder):
60+
To generate a PDF of the documentation, simply run (from the root project
61+
folder):
6362

6463
```sh
6564
make -C docs latexpdf

docs/contribute.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ It might be useful to become familiar with them:
2323

2424
There are 3 main categories of repos:
2525

26-
- The [_SimPhoNy_ repository](https://github.com/simphony/osp-core/tree/v4.0.0rc4)
26+
- The [_SimPhoNy_ repository](https://github.com/simphony/simphony-osp/tree/v4.0.0)
2727
contains the nucleus of SimPhoNy, the base on which the wrappers build.
2828
- Each _wrapper_ will be in its own repository on GitHub or GitLab,
2929
mimicking
3030
[wrapper_development](https://github.com/simphony/wrapper-development).
31-
- [_docs_](https://github.com/simphony/docs/tree/v4.0.0rc4)
31+
- [_docs_](https://github.com/simphony/docs/tree/v4.0.0)
3232
holds the source for this documentation.
3333

3434
There are also 4 types of branches:
@@ -100,21 +100,21 @@ workflow, and the different commits used to synchronise them:
100100
[Flake8](https://github.com/pycqa/flake8) tool. The validation is also
101101
enforced on the repository by the
102102
[continuous integration](contribute.md#continuous-integration). Click
103-
[here](https://github.com/simphony/osp-core/blob/master/.github/workflows/ci.yml#L12)
103+
[here](https://github.com/simphony/simphony-osp/blob/v4.0.0/.github/workflows/ci.yml#L12)
104104
to see the specific options with which Flake8 is launched.
105105
- All Python code should be reformatted with
106106
[black](https://github.com/psf/black) and
107107
[isort](https://github.com/PyCQA/isort). The use of said tools is
108108
enforced by the
109109
[continuous integration](contribute.md#continuous-integration). Therefore,
110110
we strongly recommend that you use the
111-
[configuration file](https://github.com/simphony/osp-core/blob/master/.pre-commit-config.yaml)
111+
[configuration file](https://github.com/simphony/simphony-osp/blob/v4.0.0/.pre-commit-config.yaml)
112112
bundled with the repository to
113113
[install](https://pre-commit.com/#installation) the
114114
[pre-commit framework](https://pre-commit.com/), that automates the task
115115
using git pre-commit hooks.
116116
- A few
117-
[other style conventions](https://github.com/simphony/osp-core/blob/master/.pre-commit-config.yaml)
117+
[other style conventions](https://github.com/simphony/simphony-osp/blob/v4.0.0/.pre-commit-config.yaml)
118118
are also enforced by the continuous integration through
119119
[pre-commit](https://pre-commit.com/) (such as empty lines at the end of
120120
text files). If you decide not to use it, the CI will let you know what
@@ -132,11 +132,11 @@ workflow, and the different commits used to synchronise them:
132132
- Code style conventions are enforced through the use of Flake8, black, isort,
133133
and various
134134
[pre-commit](https://pre-commit.com/)
135-
[hooks](https://github.com/simphony/osp-core/blob/master/.pre-commit-config.yaml).
135+
[hooks](https://github.com/simphony/simphony-osp/blob/v4.0.0/.pre-commit-config.yaml).
136136
- Tests are automatically run for all pull requests.
137137
- For the OSP-core code, benchmarks are run after every merge to `dev`.
138138
Benchmark results are available
139-
[here](https://simphony.github.io/osp-core/dev/bench/index.html). The CI
139+
[here](https://simphony.github.io/simphony-osp/dev/bench/index.html). The CI
140140
will report a failure when a benchmark is 50% slower than in the previous
141141
run, in addition to automatically commenting on the commit.
142142

docs/developers/wrappers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,4 +314,4 @@ the server with small amounts of large exchanges of information.
314314
This page is meant to offer a mid-level view on what SimPhoNy Wrappers are
315315
and how do they work. If you are interested in developing one, you may find a
316316
template for building and packaging a wrapper in the
317-
[wrapper development repository](https://github.com/simphony/wrapper-development/tree/v4.0.0rc5).
317+
[wrapper development repository](https://github.com/simphony/wrapper-development/tree/v4.0.0).

docs/index.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
# Welcome to the SimPhoNy documentation!
22

3-
```{note}
4-
⚠️ You are reading the documentation of a release candidate version of
5-
SimPhoNy. The documentation for the latest
6-
stable version of SimPhoNy can be found
7-
[here](https://simphony.readthedocs.io/en/latest/).
8-
```
9-
103
The SimPhoNy Open Simulation Platform is a framework that aims to achieve
114
interoperability between software such as simulation engines, databases and
125
data repositories using a knowledge graph as the common language. It is focused

docs/introduction/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ required. SimPhoNy is
77
installed using the [`pip` package manager](https://pip.pypa.io/en/stable/).
88

99
```shell
10-
pip install osp-core
10+
pip install simphony-osp
1111
```
1212

1313
## Wrapper installation
@@ -23,7 +23,7 @@ instructions.
2323
## Developers
2424

2525
If you are a developer or an advanced user, you might be interested in
26-
installing OSP-core from source.
26+
installing SimPhoNy from source.
2727

2828
```shell
2929
git clone https://github.com/simphony/simphony-osp.git

docs/introduction/quickstart.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"source": [
1616
"<figure style=\"display: table; text-align:center; margin-left: auto; margin-right:auto\">\n",
1717
" \n",
18-
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/simphony/docs/v4.0.0rc4?filepath=docs%2Fintroduction%2Fquickstart.ipynb \"Click to run this tutorial yourself!\")\n",
18+
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/simphony/docs/v4.0.0?filepath=docs%2Fintroduction%2Fquickstart.ipynb \"Click to run this tutorial yourself!\")\n",
1919
" \n",
2020
"</figure>\n",
2121
"\n",

docs/links.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SimPhoNy:
66

77
- [GitLab's SimPhoNy group](https://gitlab.cc-asp.fraunhofer.de/simphony)
88
- [GitHub's SimPhoNy group](https://github.com/simphony)
9-
- [SimPhoNy repository](https://github.com/simphony/osp-core)
9+
- [SimPhoNy repository](https://github.com/simphony/simphony-osp)
1010
- [wrappers](https://gitlab.cc-asp.fraunhofer.de/simphony/wrappers)
1111
- [wrapper development](https://github.com/simphony/wrapper-development)
1212

@@ -18,7 +18,7 @@ Technologies used:
1818

1919
# Acknowledgements
2020

21-
SimPhoNy OSP-core and wrappers development is supported by the following Grants:
21+
SimPhoNy is supported by the following grants:
2222

2323
```{eval-rst}
2424
============= ============ =============================== ==================
@@ -44,4 +44,5 @@ We would like to acknowledge and thank our project partners, especially
4444
[Centre Internacional de Mètodes Numèrics a l'Enginyeria (CIMNE)](https://cimne.com/)
4545
and the [University of Jyväskylä](https://www.jyu.fi/en), for their important
4646
contributions to some of the core concepts of SimPhoNy, which were originally
47-
demonstrated under the project https://github.com/simphony/simphony-common.
47+
demonstrated under the project
48+
[simphony-common](https://github.com/simphony/simphony-common).

docs/usage/assertional_knowledge.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"\n",
99
"<figure style=\"display: table; text-align:center; margin-left: auto; margin-right:auto\">\n",
1010
"\n",
11-
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/simphony/docs/v4.0.0rc4?filepath=docs%2Fusage%2Fassertional_knowledge.ipynb \"Click to run this tutorial yourself!\")\n",
11+
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/simphony/docs/v4.0.0?filepath=docs%2Fusage%2Fassertional_knowledge.ipynb \"Click to run this tutorial yourself!\")\n",
1212
" \n",
1313
"</figure>"
1414
]
@@ -138,7 +138,7 @@
138138
"<div class=\"admonition note\">\n",
139139
"<div class=\"admonition-title\" style=\"font-weight: bold\"><div style=\"display: inline-block\">Note</div></div>\n",
140140
"\n",
141-
"At the moment, it is not possible to instantiate multi-class individuals. We [are aware of this issue](https://github.com/simphony/osp-core/issues/669), and planning to include this functionality in a future minor release.\n",
141+
"At the moment, it is not possible to instantiate multi-class individuals. We [are aware of this issue](https://github.com/simphony/simphony-osp/issues/669), and planning to include this functionality in a future minor release.\n",
142142
"\n",
143143
"Until this is fixed, the suggested workaround is to instantiate an ontology individual of any class and change the classes _a posteriori_, just as shown below.\n",
144144
" \n",

docs/usage/sessions/import_export.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"source": [
1616
"<figure style=\"display: table; text-align:center; margin-left: auto; margin-right:auto\">\n",
1717
" \n",
18-
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/simphony/docs/v4.0.0rc4?filepath=docs%2Fusage%2Fsessions%2Fimport_export.ipynb \"Click to run this tutorial yourself!\")\n",
18+
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/simphony/docs/v4.0.0?filepath=docs%2Fusage%2Fsessions%2Fimport_export.ipynb \"Click to run this tutorial yourself!\")\n",
1919
" \n",
2020
"</figure>\n",
2121
"\n",

docs/usage/sessions/introduction.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"\n",
99
"<figure style=\"display: table; text-align:center; margin-left: auto; margin-right:auto\">\n",
1010
"\n",
11-
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/simphony/docs/v4.0.0rc4?filepath=docs%2Fusage%2Fsessions%2Fintroduction.ipynb \"Click to run this tutorial yourself!\")\n",
11+
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/simphony/docs/v4.0.0?filepath=docs%2Fusage%2Fsessions%2Fintroduction.ipynb \"Click to run this tutorial yourself!\")\n",
1212
" \n",
1313
"</figure>"
1414
]

0 commit comments

Comments
 (0)