Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
psimpy
Manage
Activity
Members
Labels
Plan
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
mbd
psimpy
Commits
59046f3b
Commit
59046f3b
authored
2 years ago
by
Hu Zhao
Browse files
Options
Downloads
Patches
Plain Diff
docs: add instruction on how to use with jupyter notebook
parent
46761ac8
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+19
-5
19 additions, 5 deletions
README.md
with
19 additions
and
5 deletions
README.md
+
19
−
5
View file @
59046f3b
...
...
@@ -73,12 +73,26 @@ conda install -c conda-forge pip
pip
install
psimpy
```
Now you should have
`PSimPy`
and its dependencies successfully installed.
Now you should have
`PSimPy`
and its dependencies successfully installed in your
conda environment. You can use it in the Python terminal or in your Python IDE.
If you would like to use it with Jupyter Notebook (iPython Notebook), there is
one extra step needed to set your conda environment on your Notebook:
6.
Install
`ipykernel`
and install a kernel that points to your conda environment
by
```
bash
conda
install
-c
conda-forge ipykernel
python
-m
ipykernel
install
--user
--name
=
your_env_name
```
Now you can start your Notebook, change the kernel to your conda environment, and
use
`PSimPy`
.
## Usage
Examples are currently in preparation and will be available soon in coming
versions. You may want to have a look at the tests which are currently available
at https://git-ce.rwth-aachen.de/mbd/psimpy. They give a glimpse of how
`PSim
p
y`
at https://git-ce.rwth-aachen.de/mbd/psimpy. They give a glimpse of how
`PSim
P
y`
can be used. You may download the
`tests`
folder onto your local machine, and run
any test using
`pytest`
.
...
...
@@ -97,10 +111,10 @@ or a specific test like `test_active_learning` by
pytest tests/test_active_learning.py
```
Some tests save results including plots into temporary folders. The temporary
folders will be deleted automatically if
`test_clear_temp_file`
is called. If
you want to exclude a specific test such as
`test_clear_temp_file`
, you may run
folders will be deleted automatically if
`test_clear_temp_file
s
`
is called. If
you want to exclude a specific test such as
`test_clear_temp_file
s
`
, you may run
```
bash
pytest tests/
--ignore
=
tests/test_clear_temp_file.py
pytest tests/
--ignore
=
tests/test_clear_temp_file
s
.py
```
## Documentation
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment