Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
PyFstat
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
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
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
Pep Covas Vidal
PyFstat
Commits
968f9833
Commit
968f9833
authored
5 years ago
by
David Keitel
Browse files
Options
Downloads
Patches
Plain Diff
update README.md to recommend pip-from-git as easiest way
parent
0db18d72
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
+42
-16
42 additions, 16 deletions
README.md
with
42 additions
and
16 deletions
README.md
+
42
−
16
View file @
968f9833
...
@@ -34,20 +34,31 @@ to `conda`, `pip` is more universal).
...
@@ -34,20 +34,31 @@ to `conda`, `pip` is more universal).
This can be installed with
This can be installed with
```
```
$
conda install pip
conda install pip
```
```
### Clone the repository
### install PyFstat the easy way
In a terminal, clone the directory:
Currently, the easiest way to install PyFstat is to point pip to this git repository,
which will give you the latest master version:
```
pip install git+https://gitlab.aei.uni-hannover.de/GregAshton/PyFstat
```
or, if you have an ssh key installed in this gitlab instance:
```
```
$ git clone https://
gitlab.aei.uni-hannover.de/GregAshton/PyFstat
.git
pip install git+ssh://git@
gitlab.aei.uni-hannover.de/GregAshton/PyFstat
```
```
(The release on Zenodo is outdated and might not even install depending on your python version.
New Zenodo and/or PyPi releases are on our to-do list.)
See further down for installing manually from a local git clone.
### Dependencies
### Dependencies
`pyfstat`
uses the following external python modules:
PyFstat uses the following external python modules,
which should all be pulled in automatically if you use pip:
*
[
numpy
](
http://www.numpy.org/
)
*
[
numpy
](
http://www.numpy.org/
)
*
[
matplotlib
](
http://matplotlib.org/
)
>= 1.4
*
[
matplotlib
](
http://matplotlib.org/
)
>= 1.4
...
@@ -66,12 +77,13 @@ $ git clone https://gitlab.aei.uni-hannover.de/GregAshton/PyFstat.git
...
@@ -66,12 +77,13 @@ $ git clone https://gitlab.aei.uni-hannover.de/GregAshton/PyFstat.git
option of the TransientGridSearch class.
option of the TransientGridSearch class.
(Note: 'pip install pycuda' requires a working nvcc compiler in your path.)
(Note: 'pip install pycuda' requires a working nvcc compiler in your path.)
For an introduction to installing modules see
In case the automatic install doesn't properly pull in all dependencies,
[
here
](
https://docs.python.org/3.5/installing/index.html
)
. If you are using
to install all of these modules manually, you can also run
`pip`
, to install all of these modules, run
```
```
$
pip install -r /PATH/TO/THIS/DIRECTORY/requirements.txt
pip install -r /PATH/TO/THIS/DIRECTORY/requirements.txt
```
```
For a general introduction to installing modules, see
[
here
](
https://docs.python.org/3.5/installing/index.html
)
.
If you prefer to make your own LALSuite installation
If you prefer to make your own LALSuite installation
[
https://git.ligo.org/lscsoft/lalsuite/
](
from
source),
[
https://git.ligo.org/lscsoft/lalsuite/
](
from
source),
...
@@ -79,21 +91,35 @@ make sure it is **swig-enabled** and contains at least the `lalpulsar` package.
...
@@ -79,21 +91,35 @@ make sure it is **swig-enabled** and contains at least the `lalpulsar` package.
A minimal confuration line to use would be e.g.:
A minimal confuration line to use would be e.g.:
```
```
$
./configure --prefix=${HOME}/lalsuite-install --disable-all-lal --enable-lalpulsar --enable-lalapps --enable-swig
./configure --prefix=${HOME}/lalsuite-install --disable-all-lal --enable-lalpulsar --enable-lalapps --enable-swig
```
```
### PyFstat installation
### PyFstat installation
from source
The module and associated scripts can be installed system wide (or to the currently active venv),
In a terminal, clone the directory:
```
git clone https://gitlab.aei.uni-hannover.de/GregAshton/PyFstat.git
```
The module and associated scripts can be installed system wide
(or to the currently active venv),
assuming you are in the source directory, via
assuming you are in the source directory, via
```
```
$
python setup.py install
python setup.py install
```
```
or simply add this directory to your python path. To check that the installation
As a developer, alternatively
```
python setup.py develop
```
can be useful so you can directly see any changes you make in action.
Alternatively, add the source directory directly to your python path.
To check that the installation
was successful, run
was successful, run
```
```
$
python -c 'import pyfstat'
python -c 'import pyfstat'
```
```
if no error message is output, then you have installed
`pyfstat`
. Note that
if no error message is output, then you have installed
`pyfstat`
. Note that
the module will be installed to whichever python executable you call it from.
the module will be installed to whichever python executable you call it from.
...
...
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