Installation
FEBISS can be installed using pip (pip3) once the repository has been cloned:
git clone https://github.com/PodewitzLab/FEBISS.git
pip install ./febissA non super user can install the package using a virtual environment, or the --user flag.
A manual with detailed instructions can be found in the Github repo.
Prerequisites
Basic Requirements
FEBISS is expected to run on Linux systems and the following programs/packages are required:
Python3
Git
GCC >= v7.0.0
Febiss Python Package
The main Python package called FEBISS requires only basic additional packages, which will be automatically installed when installing FEBISS, using pip. These packages are listed in the file requirements.txt.
C++ Requirements
To run analyses of trajectories the open-source software CPPTRAJ modified with the GIGIST repository is used. These dependencies are not necessary for the installation of FEBISS, but rather FEBISS provides a script to set-up these dependencies via
febiss_setupPlease be aware that CPPTRAJ may require libraries that cannot be installed via FEBISS, but have to be installed by the user first. CPPTRAJ makes use of the following libraries:
NetCDF
BLAS
LAPACK
Gzip
Bzip2
Parallel NetCDF (-mpi build only, for NetCDF trajectory output in parallel)
CUDA (-cuda build only)
FFTW (mostly optional; required for PME functionality and very large FFTs)
We therefore recommend to install some basic libraries via
sudo apt-get install libblas-dev liblapack-dev libbz2-dev libnetcdf-devShould you encounter difficulties in the installation of CPPTRAJ, we refer to the README of the GIGIST and CPPTRAJ repositories.
Basic Usage
If you installed FEBISS and its dependencies febiss_setup, you can use FEBISS to analyse trajectories for water placements, plot the data and select the waters you want to further investigate within a bar chart.
To get a list of all available options and a useful input file, you can call
febiss_settingsThis will place the file all-settings.yaml in your current directory. This input file requires only 2 alterations to be a valid input file. You have to give the name of your topology file and the base name of your trajectory file(s). Along those 2 mandatory settings you find all other available settings both for the GIST analysis and the plotting of the retrieved data. Once you performed the analysis, you can also skip this step and directly plot the data. The analysis and plotting are done via calling the main program along with the yaml input file:
febiss all-settings.yaml1 maintainer
Metadata
1 maintainer
Release files for Febiss 0.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| Febiss-0.9.0.tar.gz | 17.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Febiss-0.9.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.3 kB
Release files / Febiss-0.9.0.tar.gz
| Download URL | Febiss-0.9.0.tar.gz |
|---|---|
| Size | 17.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fbbd863f29924c3ad751e79ef82b0d0771eb75c9c47a0e75fce095b1522db1af
|
|
BLAKE2b-256 checksum How to use checksums |
2e05d5f3e12ae571f2f4f69e78ae4fd32dfe2f0f122754f84a1caf9703ce451d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
|
Release files / Febiss-0.9.0-py3-none-any.whl
| Download URL | Febiss-0.9.0-py3-none-any.whl |
|---|---|
| Size | 23.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e6c028bc14192ffc92e195e29629de22244eba093f666b643333806833dcbe0e
|
|
BLAKE2b-256 checksum How to use checksums |
053ee3ad62a4d2829ab8aa29b5b87307107d009b111632ca2a38f6a7e54f0456
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
|
