Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
mutalyzer
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Analyze
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
Show more breadcrumbs
Mirrors
mutalyzer
Commits
670ec1a2
Commit
670ec1a2
authored
10 years ago
by
Vermaat
Browse files
Options
Downloads
Patches
Plain Diff
Update installation instructions in documentation
Based on comments by Jeroen in issue #14.
parent
21063cdf
No related branches found
No related tags found
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
doc/download.rst
+42
-0
42 additions, 0 deletions
doc/download.rst
doc/index.rst
+1
-0
1 addition, 0 deletions
doc/index.rst
doc/install.rst
+1
-1
1 addition, 1 deletion
doc/install.rst
doc/run.rst
+3
-0
3 additions, 0 deletions
doc/run.rst
with
47 additions
and
1 deletion
doc/download.rst
0 → 100644
+
42
−
0
View file @
670ec1a2
.. highlight:: none
.. _download:
Downloading Mutalyzer
=====================
The Mutalyzer source code is `hosted on the LUMC GitLab server
<https://git.lumc.nl/mutalyzer/mutalyzer>`_. The recommended way to get the
Mutalyzer source code is by cloning the `Git`_ repository::
git clone https://git.lumc.nl/mutalyzer/mutalyzer.git
This will give you the current development version. See below for working with
other versions.
Release versions
----------------
All Mutalyzer releases are tagged. You can run ``git tag`` to list the
available tags. Use ``git checkout <tag>`` to switch to a certain release. For
example, to swith to the `2.0.0` release::
git checkout v2.0.0
Alternatively, you can checkout the `release` branch. This branch always
points to the latest Mutalyzer release.
Archive downloads
-----------------
If for whatever reason you don't want to use Git, you can download the source
code directly as a zip archive or tarball. The current development version can
be found from the `project homepage
<https://git.lumc.nl/mutalyzer/mutalyzer>`_. Archive downloads for release
versions can be found on the `tags page
<https://git.lumc.nl/mutalyzer/mutalyzer/tags>`_.
.. _Git: http://git-scm.com/
This diff is collapsed.
Click to expand it.
doc/index.rst
+
1
−
0
View file @
670ec1a2
...
...
@@ -16,6 +16,7 @@ Information for getting Mutalyzer running on a system.
.. toctree::
:maxdepth: 2
download
install
config
run
...
...
This diff is collapsed.
Click to expand it.
doc/install.rst
+
1
−
1
View file @
670ec1a2
...
...
@@ -100,7 +100,7 @@ covered here.
Assuming you created and activated a virtual environment for Mutalyzer,
install all required Python packages::
$ sudo apt-get install python-dev libmysqlclient-dev
$ sudo apt-get install python-dev libmysqlclient-dev
libxml2-dev libxslt-dev
$ pip install -r requirements.txt
Now might be a good time to run the unit tests::
...
...
This diff is collapsed.
Click to expand it.
doc/run.rst
+
3
−
0
View file @
670ec1a2
...
...
@@ -5,6 +5,9 @@
Running Mutalyzer
=================
Please make sure Mutalyzer can find its configuration file, as detailed in
:ref:`config`.
Mutalyzer comes with a number of different interfaces, of which the website is
perhaps the main one. It can be started using a built-in test server that's
useful for development and debugging purposes like this::
...
...
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