Skip to content

Commit

Permalink
Adding more readme and try version controlling
Browse files Browse the repository at this point in the history
  • Loading branch information
koehlale committed May 6, 2024
1 parent 9efe812 commit 6101bb2
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 2 deletions.
9 changes: 9 additions & 0 deletions .github/workflows/versioning.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: Versioning the pyproject.toml file
run-name: ${{github.actor}} is changing the version number
on: [commit]
jobs:
Changing the Version number:
runs-on: ubuntu-latest
steps:
-run: poetry version patch
-run: echo "The new version is ${{poetry version}}"
91 changes: 90 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,90 @@
# A_First_Approach_to_Quantum_Logical_Shape_Classification_Framework
# A First Approach to Quantum Logical Shape Classification Framework

## Virtual environment

Using a virtual environment helps us to control all packages and their versions.

### Creating a virtual environment

We recommend the [Poetry](https://python-poetry.org/docs/#installation) package, since it is a great tool for dependency management.

#### Using `Poetry`

0. _(optional)_ create virtual environments inside the project folder

```bash
poetry config virtualenvs.create true --local
poetry config virtualenvs.in-project true --local
```

`--local` can be ignored, if you wish to have these settings global.

1. Install packages and create virtual environment

```bash
poetry install --no-root
```

2. Run the code via a single line of code

```bash
poetry run python main.py
```

or entering the virtual environment via

```bash
poetry shell
```

and then run the code inside the virtual environment via

```bash
python main.py
```

#### Using `venv`

1. creating virtual environment

```bash
python -m venv .venv
```

2. activate

```bash
source .venv/bin/activate
```

3. install packages

```bash
python -m pip install requirements.txt
```

4. run

```bash
python main.py
```

5. If no longer needed deactivate it

```bash
deactivate
```

### Packages

Here we want to provide an overview of the packages we use.

#### Using `Poetry`

The command

```bash
poetry show
```

provides a list of all packages
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "a-first-approach-to-quantum-logical-shape-classification-framework"
version = "0.1.0"
version = "0.1.1"
description = "later"
authors = ["Alex <koehlale@b-tu.de>"]
license = "MIT"
Expand Down

0 comments on commit 6101bb2

Please sign in to comment.