# What is BioShell¶

BioShell is a general bioinformatics toolkit, focused on biomolecular structures. It provides:

Command line applications
that have been distributed since the original 1.0 version of the package. Some of them have changed their names (e.g. HCPM has been renamed to clust)
Many (currently over a hundred) small applications
that also serve as integration tests. They come with example input data and expected output
Python library
majority of BioShell classes may be directly used in Python
C++ library
which offers highly optimized implementations of oftenly used BioInformatics algorithms and protocols.

## BioShell functionality¶

BioShell functionality covers file processing such as data filtering and file formats convertion. It handle protein sequences, sequence profiles and alignments. Structures calculations capabilities include superimpositions, crmsd calculations, alignments, Phi/Psi angles and many more.

Since its first publication, BioShell has been providing a small set of command-line programs for easy data manipulation from a UNIX-like terminal or a shell script. The newest release extends this set by over a hundred simple command-line utilities. See examples page to see which program can help you in solving a particular problem.

## BioShell command-line utilities¶

The original BioShell command line utilities are still maintained, although their functionality is a bit redundant with applications released with BioShell 3.0 version. See Programs page for details.

## BioShell tests & examples¶

Since the most recently published version 3.0, BioShell package comes with extensive set of example applications, which have been created to simultaneously reach tree goals:

• to extend the set of BioShell command line tools. Programs with names starting with ap_ are in fact yet another applications. The difference between these test and standard apps is that the latter perform only a single action and their command line is simplified. These programs are integration tests at the same time.
• to provide high quality code snippets that help BioShell users write their own programs. Small programs, that show how to use a particular class or a function, are named ex_*. At the same time they serve as unit tests
• to test the code. Both ex_* and ap_* tests are automatically executed by a test server to ensure the quality and integrity of the package. Input data as well as curated output of these tests is versioned in git repository along the source code.

All the examples are included in respective API documentation pages. Since the test are continuously tested, the serve as a source of validated snippets for creating future programs.

## BioShell library for Python (aka PyBioShell)¶

BioShell distribution provides also bindings to Python scripting language; that is, BioShell is also a versatile library for python scripting. BioShell objects can be imported as any other python modules. Example scripts are also included in the repository.

Precompiled library (a single .so file) for Unix distribitions can be downloaded for the following Python versions. Click on an appropriate link below:

or type this command in your terminal:

curl -O http://bioshell.pl/downloads/bioshell/Python37/pybioshell.so


Remember to add path with pybioshell.so to your PyBioShell script eg.

sys.path.append('/home/username/src.git/bioshell/bin/')


If you really need to compile your own version follow the instructions here

## Previous versions¶

### BioShell versions 1.x¶

The original BioShell package was designed as a suite of programs designed for pre- and post-processing in protein structure modeling protocols. The package has been providing a convenient set of tools for in conversion between various sequence and structure formats. It has been also possible to calculate simple properties of protein conformations. The very first commands (e.g. HCPM for clustering protein structures) were implemented in C, later on the development switched to C++.

### BioShell versions 2.x¶

Around 2006/07 BioShell has been reimplemented in JAVA, designed as a library for scripting languages running on Java Virtual Machine, most notably Python, but also Scala, Ruby, Groovy and many others. Currently the most recent stable release is 2.2. API docs as well as example scripts may be found in documentation. All program from 1.x versions were also ported to JAVA.

## Citations¶

• BioShell - the third version:
Joanna M. Macnar, Natalia A. Szulc, Justyna D. Kryś, Aleksandra E. Badaczewska-Dawid and Dominik Gront “BioShell 3.0: Library for processing structural biology data.” submitted to MDPI Biomolecules