Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing to SBSCL

Thank you for your interest in contributing to SBSCL! If you would like to make improvements to the library, add new features that are useful to you and others, or have found a bug that you know how to fix, please open a pull request!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We appreciate your interest in contributing to SBSCL! If you would like to make improvements to the library, add new useful features, or have found a bug you know how to fix, please open a pull request!


## How to Contribute

### Reporting Bugs

If you find a bug, please open a new issue on our [Issue Tracker](https://github.com/draeger-lab/SBSCL/issues) and provide the following information:

* **Expected behavior:** What should happen?
* **Actual behavior:** What is happening instead?
* **Reproduction steps:** Clear, concise steps to reproduce the issue.
* **Environment:** Your operating system, version of the project etc.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

, etc.

* **Screenshots or error messages:** If applicable.

### Suggesting Enhancements

For feature requests or enhancements, please open a new issue on our [Issue Tracker](https://github.com/draeger-lab/SBSCL/issues) and describe:

* **The problem you are trying to solve.**
* **Your proposed solution or enhancement.**
* **Any alternative solutions you have considered.**

### Code Contributions

1. **Fork** the repository and **clone** it locally.
2. **Create a new branch** for your changes: `git checkout -b your-feature-name`.
3. **Make your changes** and ensure they adhere to our [Coding Style Guide Link, if applicable].
4. **Write tests** for your changes to ensure functionality and prevent regressions.
5. **Commit your changes** with a clear and descriptive commit message.
6. **Push your branch** to your fork: `git push origin your-feature-name`.
7. **Open a Pull Request (PR)** to the upstream repository.
* Provide a clear description of your changes.
* Reference any related issues.

## Development Setup

For more information regarding the installation, refer to [INSTALL.md](INSTALL.md)

## Getting Help

If you have questions or need assistance, please feel free to:

* Open an issue on our [Issue Tracker](https://github.com/draeger-lab/SBSCL/issues).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please open…

* Ask to any maintainer.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or you may ask any maintainer.


We appreciate your contributions and look forward to collaborating with you!
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,9 @@ Bio-Informatics, Libraries, Simulations
### For users
For an introduction on how to use this library for simulation, please refer to the [UserGuidelines.md](UserGuidelines.md) file. There you can find explanations on how to simulate different models and code snippets, including the links to the complete code examples.

### For developers
To start working on SBSCL, you should first clone the repository and then refer to [INSTALL.md](INSTALL.md) which gives instruction to run maven build. Once a maven build is ran, the binaries will be generated in the target folder. This folder will also include a JAR files of the simulation core library to work with.
### For Contributors
New contributors can refer to [CONTRIBUTING.md](CONTRIBUTING.md) which gives instruction about the build process and contribution guidelines. <br>
You can also refer to [INSTALL.md](INSTALL.md) which gives instruction to run maven build. Once a maven build is ran, the binaries will be generated in the target folder. This folder will also include a JAR files of the simulation core library to work with.

For an introduction on how things currently work in SBSCL to simulate different models, please refer to the sequence diagrams present in the [/dev/diagrams/](https://github.com/draeger-lab/SBSCL/tree/master/dev/diagrams/) where you can understand complete workflow of the library. Once you get familiarized with how things work, please open the javadoc [homepage](https://draeger-lab.github.io/SBSCL/apidocs/overview-summary.html) where you can find the complete information about the library properly documented. For formatting the code-base, please refer to [formatting-guidelines](https://github.com/draeger-lab/SBSCL/tree/master/dev/formatting-guidelines/).

Expand Down Expand Up @@ -107,6 +108,8 @@ The package structure in more detail:
|- test -> JUnit test files along with resources required
|- site -> Contains markup files, old javadoc, site.xml and other website
resources
|- CONTRIBUTING.md -> Contains the guidelines and instructions for new contributors
|- INSTALL.md -> Contains the instruction to run maven build
|- LICENSE.txt -> the license, under which this project is distributed
|- pom.xml -> Maven file for building the project
|- README.md -> this file
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/org/testsuite/SBMLTestSuiteRunnerWrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import org.sbml.jsbml.ext.fbc.FBCConstants;
import org.sbml.jsbml.validator.ModelOverdeterminedException;
import org.simulator.comp.CompSimulator;
import org.simulator.examples.CompExample;
import org.simulator.fba.FluxBalanceAnalysis;
import org.simulator.io.CSVImporter;
import org.simulator.math.odes.AbstractDESSolver;
Expand Down Expand Up @@ -60,7 +59,7 @@ public class SBMLTestSuiteRunnerWrapper {
public static final String RELATIVE = "relative";
public static final String NAN = "NaN";
private static final double TOLERANCE_FACTOR = 1E-5;
private static final Logger LOGGER = Logger.getLogger(CompExample.class.getName());
private static final Logger LOGGER = Logger.getLogger(SBMLTestSuiteRunnerWrapper.class.getName());

/**
* The wrapper executes the simulation of a given SBML file and writes result to a specified CSV
Expand Down