Skip to content

Commit

Permalink
update readme a bit; few minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Vadim Nazarov committed Aug 19, 2015
1 parent 3172761 commit 4bd02e0
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 18 deletions.
44 changes: 26 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,13 @@ Undetailed dependencies. For more information on dependencies see `Installing an

You can use Ymir in two ways:

- as a library in your project or

- using pre-made scripts for the most common tasks - computation of generation probabilities (sometimes I call them "assembling probabilities",
estimation of parameters of an immune receptor assembling model from the experimental data or
generation of pre-selection immune receptor sequences.
For this tasks you need to compile some source code, but don't worry!
It's very easy, just look at the next subsection.
estimation of parameters of an immune receptor assembling model from the experimental data or generation of pre-selection immune receptor sequences.
For this tasks you need to compile some source code, but don't worry! It's very easy, just look at the next subsection.
After compiling, take a look at the `Examples / ready-to-use scripts` section where pre-made scripts are explained in details.

- as an included library in your project.

### Compiling Ymir

> Note: you can see detailed installation of dependencies in next sections.
Expand All @@ -54,19 +52,26 @@ You can load Ymir to [CLion](https://www.jetbrains.com/clion/) and compile with

#### Installation on Mac OS

1. Install [Homebrew](http://brew.sh/).
Open your Terminal.

Install [Homebrew](http://brew.sh/) by typing this into the Terminal:

2. Open your Terminal and type this:
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

After that you need to install CMake and Pythons with the following commands:

brew install cmake
brew install python
brew install python3

This tells Homebrew to install CMake, Python 2 and Python 3.
Go to [Ymir's GitHub](https://github.com/imminfo/ymir/releases) and download the latest release source code called `Source code + JSON` and unzip it.
You will see the new folder called `ymir`. Now you need to go via Terminal to Ymir's folder with `cd <path to ymir's folder here>/ymir`, e.g.
`cd ./ymir`.

3. Install JsonCPP library so Ymir can read and write JSON files:
Alternatively you could clone the repository and install JsonCPP library by the following commands:

cd $YMIR_DIR/
git clone https://github.com/imminfo/ymir.git
cd ymir
curl -sL https://github.com/open-source-parsers/jsoncpp/archive/master.zip > jsoncpp.zip
unzip jsoncpp.zip
rm jsoncpp.zip
Expand All @@ -76,7 +81,7 @@ This tells Homebrew to install CMake, Python 2 and Python 3.
mv ./dist/json ../include/json
cd ..

4. And, finally, now you can compile Ymir:
And now, finally when you are in Ymir's folder, you can compile Ymir:

mkdir build
cd build
Expand All @@ -85,17 +90,20 @@ This tells Homebrew to install CMake, Python 2 and Python 3.

Now it will build a number of programs to run Ymir: tests, benchmarks and pre-made scripts.

Now you can test it via:
You can test Ymir with:

./test/Test

and run benchmarks like this:

./benchmarks/Benchmark
And run benchmarks with:

To see how can you use pre-made scripts go to the `Examples / ready-to-use scripts` section.
curl -sL https://github.com/imminfo/ymir/releases/download/v1.0-pre2/benchmark-files.zip > benchmark-files.zip
unzip benchmark-files.zip
rm benchmark-files.zip
mv benchmark-files/ ./benchmark/
rm -r benchmark-files
./benchmark/Benchmark

Targets: scripts, tests, benchmarking, lib
To see how you can use pre-made scripts go to the `Examples / ready-to-use scripts` section.

### Using Ymir as a library

Expand Down
3 changes: 3 additions & 0 deletions test/test.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -871,6 +871,9 @@ YMIR_TEST_START(test_genesegmentalphabet)
YMIR_ASSERT(gsa[1].sequence == "ACT")
YMIR_ASSERT(gsa[3].sequence == gsa["Vseg3"].sequence)

gsa.appendPalindromicNucleotides(0, 0);
YMIR_ASSERT2(gsa[1].sequence, "ACT")

gsa.appendPalindromicNucleotides(2, 0);
YMIR_ASSERT2(gsa[1].orig_sequence, "ACT")
YMIR_ASSERT2(gsa[1].sequence, "GTACT")
Expand Down

0 comments on commit 4bd02e0

Please sign in to comment.