Installation Option B: Use NPM

*** DEPRECATED as of 2024 ****

Please use the Docker image

This installation option will require npm. It will hide the details of pulling a prebuilt Docker image or building an image from a Dockerfile. It will also hide which scripts are called to run a Docker image.

Install with npm

# for non-global installation in a folder
npm install @sjcrh/proteinpaint-container

# --- OR ---
# for global installation from any folder
npm install -g @sjcrh/proteinpaint-container

NOTE: The installation will trigger a Docker image build, which may take approximately 10 minutes.

Usage

Example usage, where the current working directory has:

• a serverconfig.json which has
  • a tpmasterdir entry, for the absolute path to the data directory
  • a "URL": "http://localhost:[PORT]" entry (default PORT=3456, can be set to any valid, non-conflicting numeric port value)
• an optional dataset folder, containing js files of any serverconfig.genomes.datasets[] entry that is not already included in proteinpaint/server/dataset

# for a full portal with html pages
npx proteinpaint-container

# open the browser to your serverconfig.URL entry
# example routes to check, assuming serverconfig.URL=http://localhost:3456
# http://localhost:3456/healthcheck
# http://localhost:3456/genomes
# http://localhost:3456 should open the Proteinpaint landing page

# Hints:
# - inspect logs with 'docker logs pp'
# - ssh into the container with 'docker exec -it pp'
# - stop the container with 'docker stop pp'