Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Nix in the Linux documentation #161

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add Nix in the Linux documentation #161

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f3a494
Update 10_Linux.md
hugtalbot Dec 11, 2024
5e93d82
Update 10_Getting_Started/20_Build/10_Linux.md
hugtalbot Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions 10_Getting_Started/20_Build/10_Linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
**It is STRONGLY advised to read through this entire doc page before getting started.**

## Preconfigured Docker image

We provide preconfigured Docker images based on Ubuntu or Fedora.
These images contain all the tools and dependencies needed to build SOFA.
Feel free to use them and to propose your own versions on Docker Hub!

Ubuntu image: [https://hub.docker.com/r/sofaframework/sofabuilder_ubuntu](https://hub.docker.com/r/sofaframework/sofabuilder_ubuntu)

Fedora image: [https://hub.docker.com/r/sofaframework/sofabuilder_fedora](https://hub.docker.com/r/sofaframework/sofabuilder_fedora)

## Supported Linux version

SOFA policy is to support only the latest Ubuntu LTS.
Expand Down Expand Up @@ -279,3 +269,27 @@ COPY\_ONLY with COPYONLY and **Configure** again.
## Compilation tutorial

See our page presenting [video tutorial for compilation on Linux](../../video-tutorials/how-to-compile-sofa/#linux).



# Alternative build methods


## Preconfigured Docker image

We provide preconfigured Docker images based on Ubuntu or Fedora.
These images contain all the tools and dependencies needed to build SOFA.
Feel free to use them and to propose your own versions on Docker Hub!

Ubuntu image: [https://hub.docker.com/r/sofaframework/sofabuilder_ubuntu](https://hub.docker.com/r/sofaframework/sofabuilder_ubuntu)

Fedora image: [https://hub.docker.com/r/sofaframework/sofabuilder_fedora](https://hub.docker.com/r/sofaframework/sofabuilder_fedora)


## Nix package

[Nix](https://nix.dev/) is a package manager which stores all packages into a common place called the Nix store, usually located at /nix/store. Each package is stored in a unique subdirectory in the store, and each package has its own tree structure. A Nix package for SOFA is available and can be used as follows:
- [Install Nix](https://nix.dev/install-nix)
- Build using `nix build github:sofa-framework/sofa` (for master). Note that you can point towards any commit hash: `nix build github:sofa-framework/sofa/COMMIT_HASH_HERE`
- Command `nix develop` provides a shell with an environment containing all required dependencies to build the project in the usual CMake way
- Finally `nix run` starts the software
hugtalbot marked this conversation as resolved.
Show resolved Hide resolved