<commit_before># Installing qsim

The qsim-Cirq interface is available as a PyPI package for Linux users. For all
other users, Dockerfiles are provided to install qsim in a contained
environment.

## Linux installation

Prior to installation, consider opening a
[virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).

qsim uses [CMake](https://cmake.org/) to ensure stable compilation of its C++
libraries across a variety of Linux distributions. CMake can be installed from
their website, or with the command `apt-get install cmake`.

TODO(@95-martin-orion): update to include pybind11 requirements.

To install qsim on Linux, simply run `pip3 install qsimcirq`. For examples of
how to use this package, see the tests in
[qsim/interfaces/tests/](interfaces/tests/).

## MacOS and Windows installation

qsim testing is currently limited to Linux. For users interested in running
qsim on a MacOS or Windows device, we recommend user the
[Docker config](docs/docker.md) provided with this repository.<commit_msg>Clarify install OS restrictions.<commit_after># Installing qsim

The qsim-Cirq interface is available as a PyPI package for Linux users. For all
other users, Dockerfiles are provided to install qsim in a contained
environment.

## Linux installation

Prior to installation, consider opening a
[virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).

qsim uses [CMake](https://cmake.org/) to ensure stable compilation of its C++
libraries across a variety of Linux distributions. CMake can be installed from
their website, or with the command `apt-get install cmake`.

TODO(@95-martin-orion): update to include pybind11 requirements.

To install qsim on Linux, simply run `pip3 install qsimcirq`. For examples of
how to use this package, see the tests in
[qsim/interfaces/tests/](interfaces/tests/).

## MacOS and Windows installation

For users interested in running qsim on a MacOS or Windows device, we strongly
recommend using the [Docker config](docs/docker.md) provided with this
repository.

### Experimental install process

Alternatively, MacOS and Windows users can follow the Linux install process,
but it is currently untested on those platforms. Users are encouraged to report
any issues seen with this process.
{'fraction_non_alphanumeric': 0.07063356164383562, 'fraction_numerical': 0.004280821917808219, 'mean_word_length': 4.961734693877551, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3658456', 'n_tokens_mistral': 630, 'n_tokens_neox': 607, 'n_words': 293}