Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
Jerico Moeyersons
Mandelbrot-creator
Commits
2502de9a
Commit
2502de9a
authored
Mar 16, 2021
by
Jerico Moeyersons
🏘
Browse files
Update readme.md
parent
4ed961cb
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
2502de9a
...
@@ -27,34 +27,13 @@ Navigate to the folder where you cloned the repository.
...
@@ -27,34 +27,13 @@ Navigate to the folder where you cloned the repository.
Navigate to the
`cli`
folder.
Navigate to the
`cli`
folder.
The cli can either be installed in your local Python environment or a virtual environment. I advise
The cli can either be installed in your local Python environment or a virtual environment.
to install it in a virtual environment. You can create them with
`venv`
,
`virtualenv`
or Anaconda
depending on your preferences. With
`conda`
you can do this as follows:
Creating the new virtual environment
:
Install the cli as follows (make sure you are in the
`cli`
folder)
:
`
conda create -n myenv
`
`
pip3 install --user --editable .
`
Activating the virtual environment:
> In some cases you must add the path to where the mandelbrot-creator is installed to your PATH. The pip3 installer will warn you about this.
`conda activate myenv`
After activating the environment it should appear in front
of your prompt, e.g. :
`(myenv) User at device in ~/bla/bla/bla`
Deactivating the virtual environment:
`conda deactivate`
(
`myenv`
is the name of your new virtual environment.)
Once you've created and activated this virtual environment (make sure
the Python version is 3.9 or higher), you can install the cli as follows
(make sure you are in the
`cli`
folder):
`pip install --editable .`
To test if the installation was successful, execute the following command:
To test if the installation was successful, execute the following command:
...
@@ -70,7 +49,7 @@ Options:
...
@@ -70,7 +49,7 @@ Options:
If you see this appearing, the cli was successfully installed!
If you see this appearing, the cli was successfully installed!
**Note: Anacod
e
is currently not available in Python version 3.9**
**Note: Anacod
a
is currently not available in Python version 3.9**
### Starting the application for the first time.
### Starting the application for the first time.
The current version of the application needs to be build the first time it is used.
The current version of the application needs to be build the first time it is used.
...
@@ -107,6 +86,7 @@ In this case, x marks the number of mandelbrots you want to calculate. The highe
...
@@ -107,6 +86,7 @@ In this case, x marks the number of mandelbrots you want to calculate. The highe
Shut down the framework with:
`mandelbrot-creator off`
.
Shut down the framework with:
`mandelbrot-creator off`
.
## Known issues
## Known issues
*
Works only on Python 3.9
*
No possibility to change the specifications of the calulcated mandelbrots
*
No possibility to change the specifications of the calulcated mandelbrots
*
A list of active workers cannot be displayed (you can check this with the docker ps command)
*
A list of active workers cannot be displayed (you can check this with the docker ps command)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment