Skip to content

Commit 78a94bd

Browse files
authored
Bump package version to 4.0.0 (#837)
* Bump package version to 4.0.0 * Replace references to `osp-core` with `simphony-osp`. * Change references to master to version-specific references. * Add knowledge-graph keyword to Python package metadata. * Add dependency `websockets >= 9`. * Remove release-candidate warning. * Change formatting of README.md
1 parent 889c962 commit 78a94bd

9 files changed

+51
-48
lines changed

.github/pull_request_template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Before submitting your pull request, please make sure that you have read and agree with the following:
2-
- [Code contribution guidelines](https://github.com/simphony/osp-core/blob/master/CONTRIBUTING.md#code)
3-
- [Code of conduct](https://github.com/simphony/osp-core/blob/master/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
4-
- [License terms](https://github.com/simphony/osp-core/blob/master/LICENSE.md)
2+
- [Code contribution guidelines](https://github.com/simphony/simphony-osp/blob/v4.0.0/CONTRIBUTING.md#code)
3+
- [Code of conduct](https://github.com/simphony/simphony-osp/blob/v4.0.0/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
4+
- [License terms](https://github.com/simphony/simphony-osp/blob/v4.0.0/LICENSE.md)
55

66
Bear in mind that the code you contribute will share the same license terms referenced above. Do not contribute code if you do not have the rights to share it under such terms.

CONTRIBUTING.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -50,60 +50,60 @@ Thank you for considering to improve SimPhoNy. We welcome your input!
5050
</table>
5151
</div>
5252

53-
Remember that you must adhere to the [Contributor Covenant Code of Conduct](https://github.com/simphony/osp-core/blob/master/CODE_OF_CONDUCT.md) if you decide to make a contribution.
53+
Remember that you must adhere to the [Contributor Covenant Code of Conduct](https://github.com/simphony/simphony-osp/blob/v4.0.0/CODE_OF_CONDUCT.md) if you decide to make a contribution.
5454

5555
## Issues
5656

5757
### Reporting bugs
5858

59-
When you find something that is not working as it should, you can submit a bug report. This section provides guidelines on how to write your report in a way that helps [maintainers](https://github.com/simphony/osp-core/blob/master/.github/CODEOWNERS) understand the problem and reproduce it. Submitting a good bug report is a key to have issues solved quickly.
59+
When you find something that is not working as it should, you can submit a bug report. This section provides guidelines on how to write your report in a way that helps [maintainers](https://github.com/simphony/simphony-osp/blob/v4.0.0/.github/CODEOWNERS) understand the problem and reproduce it. Submitting a good bug report is a key to have issues solved quickly.
6060

6161
#### Before submitting a bug report
6262

6363
1. Consider what is the possible cause of your issue. Sometimes the source of a problem is in the least expected place. For example, it could be in the ontology that you are using, in the network connection or in the software that a SimPhoNy wrapper is interacting with.
64-
2. Check the [Q&A](https://github.com/simphony/osp-core/discussions/categories/q-a) section of the [discussions page](https://github.com/simphony/osp-core/discussions). Someone else might have already experienced the same issue and got an answer on how to solve it.
65-
3. Search for similar issues on the [issue board](https://github.com/simphony/osp-core/issues?q=is%3Aissue+sort%3Aupdated-desc+). The problem may already have been reported. If you are having issues while using a specific SimPhoNy wrapper, beware that each SimPhoNy Wrapper has its own issue board.
64+
2. Check the [Q&A](https://github.com/simphony/simphony-osp/discussions/categories/q-a) section of the [discussions page](https://github.com/simphony/simphony-osp/discussions). Someone else might have already experienced the same issue and got an answer on how to solve it.
65+
3. Search for similar issues on the [issue board](https://github.com/simphony/simphony-osp/issues?q=is%3Aissue+sort%3Aupdated-desc+). The problem may already have been reported. If you are having issues while using a specific SimPhoNy wrapper, beware that each SimPhoNy Wrapper has its own issue board.
6666

6767
#### Submitting a bug report
6868

69-
Bug reports should be submitted on the [SimPhoNy issue board](https://github.com/simphony/osp-core/issues?q=is%3Aissue+sort%3Aupdated-desc+). If you suspect that the issue has its origin in the code of a specific wrapper, rather than in SimPhoNy itself, visit the issue board of the wrapper instead. To create a new report, click the green [_"New"_](https://github.com/simphony/osp-core/issues/new/choose) button.
69+
Bug reports should be submitted on the [SimPhoNy issue board](https://github.com/simphony/simphony-osp/issues?q=is%3Aissue+sort%3Aupdated-desc+). If you suspect that the issue has its origin in the code of a specific wrapper, rather than in SimPhoNy itself, visit the issue board of the wrapper instead. To create a new report, click the green [_"New"_](https://github.com/simphony/simphony-osp/issues/new/choose) button.
7070

7171
- [ ] Choose a meaningful title.
7272
- [ ] Describe the problem in few words.
7373
- [ ] Specify which version of `simphony-osp` is affected. Use `pip show simphony-osp` to find out which version you have installed. If the problem involves a wrapper, provide also the version of the wrapper.
7474
- [ ] Explain how to reproduce the problem, step-by-step, and include a **minimal reproducible example**. A _minimal reproducible example_ is a code snippet where the issue can be observed. Include any additional files (e.g. an ontology file) that may be needed to execute the example. Skip the example _only if it is very difficult to provide it_.
7575
- [ ] If the issue involves a crash or an exception, include the full error message (with the stacktrace).
7676

77-
[Follow this link](https://github.com/simphony/osp-core/issues/740#issue-1107800007) to see an example of an accurate bug report. Providing a good bug report facilitates the work of the maintainers and enables them to solve the issue faster.
77+
[Follow this link](https://github.com/simphony/simphony-osp/issues/740#issue-1107800007) to see an example of an accurate bug report. Providing a good bug report facilitates the work of the maintainers and enables them to solve the issue faster.
7878

7979
### Proposing enhancements or suggesting new features
8080

81-
Enhancements or new features should first be proposed on the [_"Ideas"_ section of the forum](https://github.com/simphony/osp-core/discussions/categories/ideas).
81+
Enhancements or new features should first be proposed on the [_"Ideas"_ section of the forum](https://github.com/simphony/simphony-osp/discussions/categories/ideas).
8282

8383
When proposing, discussing, and designing a feature or enhancement on the forum, always aim to address the following points:
8484
- [ ] Motivation for the enhancement or the new feature.
8585
- [ ] General overview of the enhancement or the new feature. Code snippets/mock-ups of how the feature or enhancement should work and behave.
8686
- [ ] Estimation of the effort that implementing such enhancement or feature might involve. Technologies that could enable the implementation. This information helps the maintainers decide whether to implement a feature or enhancement, and to estimate the timeframe for a potential implementation.
8787

88-
After this discussion phase, when the [maintainers](https://github.com/simphony/osp-core/blob/master/.github/CODEOWNERS) deem it appropriate, the discussion on the forum can be closed and an issue referencing it can be created on the [issue board](https://github.com/simphony/osp-core/issues?q=is%3Aissue+sort%3Aupdated-desc+). The goal of this procedure is to separate discussion and design from implementation efforts. The issue is now ready to be worked on. The [_code section_](#Code) explains how to contribute to solve an issue.
88+
After this discussion phase, when the [maintainers](https://github.com/simphony/simphony-osp/blob/v4.0.0/.github/CODEOWNERS) deem it appropriate, the discussion on the forum can be closed and an issue referencing it can be created on the [issue board](https://github.com/simphony/simphony-osp/issues?q=is%3Aissue+sort%3Aupdated-desc+). The goal of this procedure is to separate discussion and design from implementation efforts. The issue is now ready to be worked on. The [_code section_](#Code) explains how to contribute to solve an issue.
8989

9090
## Code
9191

9292
Code contributions are generally aimed at fixing bugs and implementing enhancements or new features. The way to contribute code to the project are [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) (PR).
9393

94-
If you are unsure about where to start, check the issues tagged as [_newcomer task_](https://github.com/simphony/osp-core/issues?q=label%3A%22%F0%9F%91%A9%E2%80%8D%F0%9F%8E%93+newcomer+task%22+sort%3Acomments-desc). Such issues should either be simple to solve, or be a good entry point for understanding the codebase.
94+
If you are unsure about where to start, check the issues tagged as [_newcomer task_](https://github.com/simphony/simphony-osp/issues?q=label%3A%22%F0%9F%91%A9%E2%80%8D%F0%9F%8E%93+newcomer+task%22+sort%3Acomments-desc). Such issues should either be simple to solve, or be a good entry point for understanding the codebase.
9595

9696
If you have a bugfix or a feature/enhancement implementation that you want to contribute, please read [this page](https://simphony.readthedocs.io/en/latest/contribute.html) to understand how the code is organized, what the meaning of the different git branches on the repository is, and what automatic checks your code will have to pass in order to be accepted. After that, just fork the repository and make a new pull request.
9797

9898
Usually, there will be an issue associated with the specific bug to solve, or feature/enhancement to implement. Please add [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) to your PR so that it becomes automatically linked to the corresponding issue.
9999

100-
After you submit your pull request, a [maintainer](https://github.com/simphony/osp-core/blob/master/.github/CODEOWNERS) will review it. It is possible that additional work is needed before the maintainer can accept the PR. To make things smoother, please consider [allowing us to directly edit your PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork), so that we can perform minor edits without having to wait for your feedback.
100+
After you submit your pull request, a [maintainer](https://github.com/simphony/simphony-osp/blob/v4.0.0/.github/CODEOWNERS) will review it. It is possible that additional work is needed before the maintainer can accept the PR. To make things smoother, please consider [allowing us to directly edit your PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork), so that we can perform minor edits without having to wait for your feedback.
101101

102102
Of course, even if you are not a maintainer, you are also very welcome to comment on the pull requests submitted by other community members and give feedback to them.
103103

104104
## Documentation
105105

106-
If you feel that the [SimPhoNy documentation](https://simphony.readthedocs.io) is difficult to understand, we welcome your feedback and contributions! In general, changes to the documentation should be first proposed on the [_"Ideas"_ section of the forum](https://github.com/simphony/osp-core/discussions/categories/ideas).
106+
If you feel that the [SimPhoNy documentation](https://simphony.readthedocs.io) is difficult to understand, we welcome your feedback and contributions! In general, changes to the documentation should be first proposed on the [_"Ideas"_ section of the forum](https://github.com/simphony/simphony-osp/discussions/categories/ideas).
107107

108108
However, in certain cases, a change in the documentation does not need to be discussed. For example, if you find a typo you can directly [create an issue](https://github.com/simphony/docs/issues/new/choose) or even a [pull request](https://github.com/simphony/docs/compare). The same applies if the documentation needs to be changed due to the implementation of enhancements or new features for SimPhoNy in a [code contribution](#code).
109109

@@ -113,16 +113,16 @@ When proposing and discussing a change on the documentation, always aim to alway
113113
- [ ] A brief description, of the proposed changes.
114114
- [ ] A mock-up of the intended changes, for example the headings, a few sentences explaining the content that should be included. If the changes involve figures, please upload a sketch too.
115115

116-
After this discussion phase, when the [maintainers](https://github.com/simphony/osp-core/blob/master/.github/CODEOWNERS) deem it appropriate, the discussion on the forum can be closed and an issue referencing it can be created on the [issue board](https://github.com/simphony/docs/issues?q=is%3Aissue+sort%3Aupdated-desc+). The goal of this procedure is to separate discussion and design from implementation efforts.
116+
After this discussion phase, when the [maintainers](https://github.com/simphony/simphony-osp/blob/v4.0.0/.github/CODEOWNERS) deem it appropriate, the discussion on the forum can be closed and an issue referencing it can be created on the [issue board](https://github.com/simphony/docs/issues?q=is%3Aissue+sort%3Aupdated-desc+). The goal of this procedure is to separate discussion and design from implementation efforts.
117117

118118
The issue is now ready to be worked on. On the issue itself, the fine details and the actual contents can be more deeply discussed. Finally, a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) can be [submitted](https://github.com/simphony/docs/compare) to the [docs repository](https://github.com/simphony/docs/pulls?q=is%3Apr+sort%3Aupdated-desc). A maintainer will review the pull request and accept it, or request further changes if needed.
119119

120120
## Forum
121121

122-
Feel free to participate on the [forum](https://github.com/simphony/osp-core/discussions)! There you may:
122+
Feel free to participate on the [forum](https://github.com/simphony/simphony-osp/discussions)! There you may:
123123

124-
- Read [announcements](https://github.com/simphony/osp-core/discussions/categories/announcements) from the SimPhoNy team.
125-
- Have [general discussions](https://github.com/simphony/osp-core/discussions/categories/general) about SimPhoNy.
126-
- Propose [new features or enhancements](https://github.com/simphony/osp-core/discussions/categories/ideas). Please follow the guidelines provided on [this section](#proposing-enhancements-or-suggesting-new-features).
127-
- [Ask other members of the community for help](https://github.com/simphony/osp-core/discussions/categories/q-a) in a [Q&A format](https://en.wikipedia.org/wiki/Q%26A_software).
128-
- [Share how did you benefit from using SimPhoNy](https://github.com/simphony/osp-core/discussions/categories/show-and-tell) in your project.
124+
- Read [announcements](https://github.com/simphony/simphony-osp/discussions/categories/announcements) from the SimPhoNy team.
125+
- Have [general discussions](https://github.com/simphony/simphony-osp/discussions/categories/general) about SimPhoNy.
126+
- Propose [new features or enhancements](https://github.com/simphony/simphony-osp/discussions/categories/ideas). Please follow the guidelines provided on [this section](#proposing-enhancements-or-suggesting-new-features).
127+
- [Ask other members of the community for help](https://github.com/simphony/simphony-osp/discussions/categories/q-a) in a [Q&A format](https://en.wikipedia.org/wiki/Q%26A_software).
128+
- [Share how did you benefit from using SimPhoNy](https://github.com/simphony/simphony-osp/discussions/categories/show-and-tell) in your project.

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,38 +15,41 @@ SimPhoNy enables:
1515
transfer them among different software products using the wrappers, and query
1616
the knowledge graph
1717

18-
⚠️ You are reading the README file for a _release candidate_ version of
19-
SimPhoNy. This version has not yet been thoroughly tested, and its
20-
functionality is not yet fully documented. Unless you are explicitly looking to
21-
try this version, please head to the
22-
[`master` branch](https://github.com/simphony/osp-core) of this repository to
23-
find the README file for the latest stable release of SimPhoNy.
24-
2518
## Installation
2619

2720
SimPhoNy is available on PyPI, so it can be installed using pip
2821

2922
`pip install simphony-osp`
3023

3124
Detailed installation instructions can be found
32-
[here](https://simphony.readthedocs.io/en/v4.0.0rc4/introduction/installation.html).
25+
[here](https://simphony.readthedocs.io/en/v4.0.0/introduction/installation.html).
3326

3427
## Documentation
3528

3629
To learn how to use SimPhoNy, check out our documentation, which is located at
37-
<https://simphony.readthedocs.io/en/v4.0.0rc4/>.
30+
<https://simphony.readthedocs.io/en/v4.0.0/>.
3831

3932
In addition, basic usage examples to
4033
quickly get started are available in the
41-
[`examples` folder](https://github.com/simphony/osp-core/tree/v4.0.0rc4/examples).
34+
[`examples` folder](https://github.com/simphony/simphony-osp/tree/v4.0.0/examples).
4235

43-
If you want to build the documentation locally, refer to our [documentation repostitory](https://github.com/simphony/docs/tree/v4.0.0rc4).
36+
If you want to build the documentation locally, refer to our
37+
[documentation repository](https://github.com/simphony/docs/tree/v4.0.0).
4438

4539
## Contributing
4640

4741
If you wish to contribute to SimPhoNy, please read the
48-
[contributing guidelines](https://github.com/simphony/osp-core/blob/v4.0.0rc4/CONTRIBUTING.md).
42+
[contributing guidelines](https://github.com/simphony/simphony-osp/blob/v4.0.0/CONTRIBUTING.md).
4943

5044
## Acknowledgements
5145

52-
The SimPhoNy Python package originates from the European Project [SimPhoNy](https://www.simphony-project.eu/) (Project Nr. 604005). We would like to acknowledge and thank our project partners, especially [Enthought, Inc](https://www.enthought.com/), [Centre Internacional de Mètodes Numèrics a l'Enginyeria (CIMNE)](https://cimne.com/) and the [University of Jyväskylä](https://www.jyu.fi/en), for their important contributions to some of the core concepts of SimPhoNy, which were originally demonstrated under the project https://github.com/simphony/simphony-common.
46+
The SimPhoNy Python package originates from the European Project
47+
[SimPhoNy](https://www.simphony-project.eu/) (Project Nr. 604005). We would
48+
like to acknowledge and thank our project partners, especially
49+
[Enthought, Inc](https://www.enthought.com/),
50+
[Centre Internacional de Mètodes Numèrics a l'Enginyeria (CIMNE)](https://cimne.com/)
51+
and the
52+
[University of Jyväskylä](https://www.jyu.fi/en),
53+
for their important contributions to some of the core concepts of SimPhoNy,
54+
which were originally demonstrated under the project
55+
[simphony-common](https://github.com/simphony/simphony-common).

examples/assertional_knowledge.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
> individuals (assertional knowledge), and ontology classes, relationships,
66
> attributes and annotations (terminological knowledge).
77
-- [Assertional knowledge - SimPhoNy documentation]
8-
(https://simphony.readthedocs.io/en/v4.0.0rc4/usage/
8+
(https://simphony.readthedocs.io/en/v4.0.0/usage/
99
assertional_knowledge.html)
1010
1111
This example focuses on accessing, editing and navigating assertional

examples/pico.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
> are YAML configuration files that, in addition to pointing to the actual
1414
> ontology files, also define extra metadata.
1515
-- [Installing ontologies (pico) - SimPhoNy documentation]
16-
(https://simphony.readthedocs.io/en/v4.0.0rc4/usage/ontologies/pico.html)
16+
(https://simphony.readthedocs.io/en/v4.0.0/usage/ontologies/pico.html)
1717
"""
1818

1919
from simphony_osp.tools.pico import install, namespaces, packages, uninstall

examples/sessions.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
> translates the assertional knowledge to a form that is compatible with a
88
> specific simulation engine, database, data repository or file format.
99
-- [Introduction (to sessions) - SimPhoNy documentation]
10-
(https://simphony.readthedocs.io/en/v4.0.0rc4/usage/sessions
10+
(https://simphony.readthedocs.io/en/v4.0.0/usage/sessions
1111
/introduction.html)
1212
1313
This example deals, however, with sessions that are NOT connected to any
@@ -50,7 +50,7 @@
5050
> In SimPhoNy, all sessions are automatically “opened” when they are created.
5151
> The “commit” and “close” operations are controlled manually.
5252
-- [Introduction (to sessions) - SimPhoNy documentation]
53-
(https://simphony.readthedocs.io/en/v4.0.0rc4/usage/sessions
53+
(https://simphony.readthedocs.io/en/v4.0.0/usage/sessions
5454
/introduction.html)
5555
5656
Note that despite the above, sessions that are not connected to a wrapper (the

0 commit comments

Comments
 (0)