Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
anis-doc
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
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
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
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
anis
anis-doc
Commits
c6c8bff0
Commit
c6c8bff0
authored
1 year ago
by
François Agneray
Browse files
Options
Downloads
Patches
Plain Diff
Update install procedure
parent
699f1830
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#10795
passed
1 year ago
Stage: build
Stage: dockerize
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/installation.md
+21
-16
21 additions, 16 deletions
docs/installation.md
with
21 additions
and
16 deletions
docs/installation.md
+
21
−
16
View file @
c6c8bff0
...
...
@@ -5,7 +5,7 @@
Here are the steps to follow to install the software locally on your machine.
The examples are realized on a linux system.
ANIS is composed of a monorepo projects tha
h
t contains
`server`
,
`client`
,
`services`
and
`tasks`
and we will see how to install the stack.
ANIS is composed of a monorepo projects that contains
`server`
,
`client`
,
`services`
and
`tasks`
and we will see how to install the stack.
## Git Repository
...
...
@@ -92,11 +92,27 @@ $ make install_tasks
The tasks dependencies packages will be downloaded and the command installs a virtual python environment in the
`tasks/venv`
directory.
This may take a few minutes. Just for information, you can find the list of dependencies in the
`tasks/requirements.txt`
file.
## Data
To works, ANIS must be associated with a data directory. This directory will serve files associated with scientific projects and datasets.
In the dev version we provide a data directory with examples files. To install them type the following command:
```
bash
$
cd
..
$
wget https://anis.lam.fr/files/anis-data.tar.gz
$
tar
xvf anis-data.tar.gz
$
rm
anis-data.tar.gz
```
At the root of the project you can see a symbolic link to the directory you just downloaded:
`data`
.
## Start application
It is now time to start the ANIS stack. To do this use the following make command:
```
bash
$
cd
anis-next
$
make start
```
...
...
@@ -113,6 +129,8 @@ You can also follow the containers logs by typing:
$
make logs
```
**Warning**
: Just wait few seconds that software completely started to continue this procedure guide.
## Databases
To works ANIS need at least two databases:
...
...
@@ -126,20 +144,6 @@ In the dev version we provide two ready-made databases. To install them type the
$
make create-db
```
## Data
To works, ANIS must be associated with a data directory. This directory will serve files associated with scientific projects and datasets.
In the dev version we provide a data directory with examples files. To install them type the following command:
```
bash
$
cd
..
$
curl https://anis.lam.fr/files/anis-data.tar.gz
$
tar
xvf anis-data.tar.gz
```
At the root of the project you can see a symbolic link to the directory you just downloaded:
`data`
.
## ANIS is ready to use!
### Server
...
...
@@ -158,7 +162,8 @@ Few examples:
### Client
*
The client is available at the following address:
`http://localhost:4200`
*
The web-ui client is available at the following address:
`http://localhost:4200`
and you can start
using the application with the test data
### Services
...
...
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