<commit_before># ![Sirepo](https://github.com/radiasoft/images/blob/master/sirepo/Sirepo_logo.png)

#### Sirepo brings computational science to the cloud. Develop, run and share your HPC simulations.

Sirepo brings Clickable Physics(TM) to your desktop and mobile devices.
No signup is required, just click [beta.sirepo.com](https://beta.sirepo.com).

We currently support the following Clickable Physics(TM) codes:

[Synchrotron Radiation Workshop](https://beta.sirepo.com/light) (SRW)

SRW computes synchrotron radiation from relativistic electrons in arbitrary magnetic fields and propagates the radiation wavefronts through optical beamlines. SRW is [open source](https://github.com/ochubar/SRW).

[Elegant](https://beta.sirepo.com/elegant)

Elegant simulates charged particle accelerators with a [wide range of features](http://www.aps.anl.gov/Accelerator_Systems_Division/Accelerator_Operations_Physics/manuals/elegant_latest/elegant.html), including support for nonlinear optimization and design. Elegant is [freely available](http://www.aps.anl.gov/Accelerator_Systems_Division/Accelerator_Operations_Physics/software.shtml#elegant) and [open source](http://www.aps.anl.gov/epics/license/open.php).

[Warp](https://beta.sirepo.com/warp#/simulations)

Warp is a particle-in-cell (PIC) code designed to simulate high-intensity charged particle beams and plasmas in both the electrostatic and electromagnetic regimes, with a wide variety of integrated physics models and diagnostics. At present, Sirepo supports a small subset of Warp’s capabilities. Warp is [open source](https://bitbucket.org/berkeleylab/warp/src) and is part of the [Berkeley Lab Accelerator Simulation Toolkit](http://blast.lbl.gov/BLASTcodes_Warp.html).

Sirepo is currently in beta.

You can use our
[curl installer on your Mac, PC (Cygwin only), or Linux box](https://github.com/radiasoft/download/blob/master/README.md)
as follows:

```bash
$ mkdir sirepo
$ cd sirepo
$ curl radia.run | bash
```

For this to work, you will need to [install the prerequisites](https://github.com/radiasoft/download/blob/master/README.md#requirements).

[API Documentation is available on Read the Docs.](http://sirepo.readthedocs.org)

### Manual Install with Docker

You can start Sirepo with [Docker](https://www.docker.com/).

If you are running Docker as an ordinary user (recommended), use the following:

```bash
$ docker run -it --rm -p 8000:8000 -v "$PWD:/vagrant" radiasoft/sirepo /radia-run "$(id -u)" "$(id -g)" /home/vagrant/bin/radia-run-sirepo /vagrant 8000
```

The `/radia-run` command ensures the guest's user can read/write files from the
current directory, which is where the database and other files will be stored.

Then visit the following link:

[http://localhost:8000/light](http://localhost:8000/light)

You can run sirepo in an emphemeral container as root, but without
storing files on the host:

```bash
# docker run -it --rm -p 8000:8000 -u vagrant radiasoft/sirepo bash -l -c 'radia-run-sirepo "$HOME" 8000'
```

### Manual Install with Vagrant

You can start Sirepo with [Vagrant](https://www.vagrantup.com/).

First create a `Vagrantfile` by copy-and-pasting this into a shell:

```bash
cat > Vagrantfile <<'EOF'
Vagrant.configure(2) do |config|
  config.vm.box = "radiasoft/sirepo"
  config.vm.network "forwarded_port", guest: 8000, host: 8000
  config.vm.synced_folder ".", "/vagrant", disabled: true
end
EOF
```

Boot the machine:

```bash
vagrant up
```

The image is 2.5GB so this will take some time to start.

If it's your first time running Vagrant, it will ask to install VirtualBox.

Follow the prompts

You can run Sirepo with a single command:<commit_msg>document new start procedure for manual install<commit_after># ![Sirepo](https://github.com/radiasoft/images/blob/master/sirepo/Sirepo_logo.png)

#### Sirepo brings computational science to the cloud. Develop, run and share your HPC simulations.

Sirepo brings Clickable Physics(TM) to your desktop and mobile devices.
No signup is required, just click [beta.sirepo.com](https://beta.sirepo.com).

We currently support the following Clickable Physics(TM) codes:

[Synchrotron Radiation Workshop](https://beta.sirepo.com/light) (SRW)

SRW computes synchrotron radiation from relativistic electrons in arbitrary magnetic fields and propagates the radiation wavefronts through optical beamlines. SRW is [open source](https://github.com/ochubar/SRW).

[Elegant](https://beta.sirepo.com/elegant)

Elegant simulates charged particle accelerators with a [wide range of features](http://www.aps.anl.gov/Accelerator_Systems_Division/Accelerator_Operations_Physics/manuals/elegant_latest/elegant.html), including support for nonlinear optimization and design. Elegant is [freely available](http://www.aps.anl.gov/Accelerator_Systems_Division/Accelerator_Operations_Physics/software.shtml#elegant) and [open source](http://www.aps.anl.gov/epics/license/open.php).

[Warp](https://beta.sirepo.com/warp#/simulations)

Warp is a particle-in-cell (PIC) code designed to simulate high-intensity charged particle beams and plasmas in both the electrostatic and electromagnetic regimes, with a wide variety of integrated physics models and diagnostics. At present, Sirepo supports a small subset of Warp’s capabilities. Warp is [open source](https://bitbucket.org/berkeleylab/warp/src) and is part of the [Berkeley Lab Accelerator Simulation Toolkit](http://blast.lbl.gov/BLASTcodes_Warp.html).

Sirepo is currently in beta.

You can use our
[curl installer on your Mac, PC (Cygwin only), or Linux box](https://github.com/radiasoft/download/blob/master/README.md)
as follows:

```bash
$ mkdir sirepo
$ cd sirepo
$ curl radia.run | bash
```

For this to work, you will need to [install the prerequisites](https://github.com/radiasoft/download/blob/master/README.md#requirements).

[API Documentation is available on Read the Docs.](http://sirepo.readthedocs.org)

### Manual Install with Docker

You can start Sirepo with [Docker](https://www.docker.com/).

If you are running Docker as an ordinary user (recommended), use the following:

```bash
$ docker run -p 8000:8000 -v "$PWD:/sirepo" radiasoft/sirepo
```

The `/radia-run` command ensures the guest's user can read/write files from the
current directory, which is where the database and other files will be stored.


Then visit the following link:

[http://localhost:8000/light](http://localhost:8000/light)

### Manual Install with Vagrant

You can start Sirepo with [Vagrant](https://www.vagrantup.com/).

First create a `Vagrantfile` by copy-and-pasting this into a shell:

```bash
cat > Vagrantfile <<'EOF'
Vagrant.configure(2) do |config|
  config.vm.box = "radiasoft/sirepo"
  config.vm.network "forwarded_port", guest: 8000, host: 8000
  config.vm.synced_folder ".", "/vagrant", disabled: true
end
EOF
```

Boot the machine:

```bash
vagrant up
```

The image is 2.5GB so this will take some time to start.

If it's your first time running Vagrant, it will ask to install VirtualBox.

Follow the prompts

You can run Sirepo with a single command:
{'fraction_non_alphanumeric': 0.10931518502764781, 'fraction_numerical': 0.009924854671770877, 'mean_word_length': 4.932716568544996, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 5, 'https://': 22, 'lorem ipsum': 0, 'www.': 10, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6283872', 'n_tokens_mistral': 2376, 'n_tokens_neox': 2204, 'n_words': 738}