Skip to content

Commit 8e49e5b

Browse files
jeongseok-metafacebook-github-bot
authored andcommitted
Add installing momentum using pixi (#38)
Summary: Pull Request resolved: #38 Now that momentum has been added to Pixi, the website and readme.md will be updated for installing momentum binaries from package managers. Reviewed By: juliencbmeta Differential Revision: D59431828 fbshipit-source-id: b2045c5dbc1294dd35c4c8d6f62837807af81377
1 parent 3b4c063 commit 8e49e5b

File tree

2 files changed

+60
-16
lines changed

2 files changed

+60
-16
lines changed

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,31 @@ numerical optimization solvers to apply human motion in various applications.
2727

2828
This page guides you through the process of building Momentum and running the examples.
2929

30-
### Prerequisite
30+
### Installing Momentum
31+
32+
Momentum binary builds are available for Windows, macOS, and Linux via [Pixi](https://prefix.dev/) or the Conda package manager.
33+
34+
#### Pixi
35+
36+
```
37+
pixi add momentum
38+
```
39+
40+
#### Conda
41+
42+
```
43+
conda install conda-forge::momentum
44+
```
45+
46+
#### Micromamba
47+
48+
```
49+
micromamba install -c conda-forge momentum
50+
```
51+
52+
### Building Momentum from Source
53+
54+
#### Prerequisite
3155

3256
Complete the following steps only once:
3357

@@ -42,9 +66,7 @@ Complete the following steps only once:
4266

4367
Ensure that all subsequent commands are executed in the project's root directory unless specified otherwise.
4468

45-
### Build Momentum
46-
47-
After completing the prerequisites, you are ready to build and use Momentum.
69+
#### Build and Test
4870

4971
- Build the project with the following command (note that the first run may take a few minutes as it installs all dependencies):
5072

@@ -60,7 +82,7 @@ After completing the prerequisites, you are ready to build and use Momentum.
6082

6183
To view all available command lines, run `pixi task list`.
6284

63-
### Running Hello World
85+
#### Hello World Example
6486

6587
To run the `hello_world` example:
6688

@@ -78,7 +100,7 @@ Alternatively, you can directly run the executable:
78100
./build/Release/hello_world.exe
79101
```
80102

81-
### Running Example
103+
#### Running Other Examples
82104

83105
To run other examples:
84106

@@ -88,7 +110,7 @@ pixi run glb_viewer --help
88110

89111
For more examples, please refer to the [Examples](https://facebookincubator.github.io/momentum/docs/examples/viewers) page.
90112

91-
### Clean Up
113+
#### Clean Up
92114

93115
If you need to start over for any reason:
94116

momentum/website/docs/02_user_guide/01_getting_started.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,31 @@ sidebar_position: 1
66

77
This page guides you through the process of building Momentum and running the examples.
88

9-
## Prerequisite
9+
## Installing Momentum
10+
11+
Momentum binary builds are available for Windows, macOS, and Linux via [Pixi](https://prefix.dev/) or the Conda package manager.
12+
13+
### Pixi
14+
15+
```
16+
pixi add momentum
17+
```
18+
19+
### Conda
20+
21+
```
22+
conda install conda-forge::momentum
23+
```
24+
25+
### Micromamba
26+
27+
```
28+
micromamba install -c conda-forge momentum
29+
```
30+
31+
## Building Momentum from Source
32+
33+
### Prerequisite
1034

1135
Complete the following steps only once:
1236

@@ -21,9 +45,7 @@ Complete the following steps only once:
2145

2246
Ensure that all subsequent commands are executed in the project's root directory unless specified otherwise.
2347

24-
## Build Momentum
25-
26-
After completing the prerequisites, you are ready to build and use Momentum.
48+
### Build and Test
2749

2850
- Build the project with the following command (note that the first run may take a few minutes as it installs all dependencies):
2951

@@ -39,7 +61,7 @@ After completing the prerequisites, you are ready to build and use Momentum.
3961

4062
To view all available command lines, run `pixi task list`.
4163

42-
## Running Hello World
64+
### Hello World Example
4365

4466
To run the `hello_world` example:
4567

@@ -54,20 +76,20 @@ Alternatively, you can directly run the executable:
5476
./build/hello_world
5577
5678
# Windows
57-
build/Release/hello_world.exe
79+
./build/Release/hello_world.exe
5880
```
5981

60-
## Running Example
82+
### Running Other Examples
6183

6284
To run other examples:
6385

6486
```
6587
pixi run glb_viewer --help
6688
```
6789

68-
For more examples, please refer to the [Examples](../examples/viewers) page.
90+
For more examples, please refer to the [Examples](https://facebookincubator.github.io/momentum/docs/examples/viewers) page.
6991

70-
## Clean Up
92+
### Clean Up
7193

7294
If you need to start over for any reason:
7395

0 commit comments

Comments
 (0)