Please find the following sections for installing Nextmv Platform components:
- Nextmv CLI: command line interface built for developers.
- Nextmv Go SDK: if you are working with Go.
- Nextmv Python SDK: if you are working with Python.
- VSCode: we recommend the use of VSCode as your code editor.
Nextmv is available for macOS and Linux. For Windows users, we recommend the use of WSL.
If you have any questions, please contact support.
Nextmv CLI
The Nextmv CLI is a command line interface that lets you easily interact with the other components of the Nextmv Platform.
Export your Nextmv API key as an environment variable:
Run the following script to install Nextmv CLI:
After downloading and installing, the last step is to configure Nextmv CLI with your account:
To display more information about a command, use help or the --help, -h flags.
Nextmv Go SDK
Nextmv Go SDK provides a set of APIs to build decision models. It also comes with a set of community apps for solving domain-specific optimization problems. Community apps include everything needed to run a model and can be used as the foundation for building a custom decision app.
First, let’s use Nextmv CLI to install Nextmv SDK locally. The following command will install Go and get the necessary plugins and other supporting files needed to build and run custom models locally.
Nextmv SDK manages its own Go installation and will not affect your current Go installation, if you have one.
If you’re on macOS you may need to run a command to allow access to Nextmv SDK. This command will be output at the end of the installation process.
Nextmv Python SDK
nextmv-py is the Python SDK, a package to interact programmatically with the Nextmv Platform from Python. It is hosted on PyPI. Python >=3.8 is required.
Install via pip:
VSCode
While not required, we recommend all users install VSCode as their code editor and the VSCode Go Extension. Windows users would also need to install the VSCode wsl extension.
WSL for Windows users
Install WSL for Windows. You can find the installation instructions here. We recommend using Ubuntu.
If this is your first time installing WSL, you may receive an error when running a Nextmv template stating that you need gcc installed. In order to do so, you have to run: