Skip to content

Commit 1d747d3

Browse files
committed
Update docs
1 parent 8ce6074 commit 1d747d3

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.rst

+18-3
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,32 @@ Install from `PyPI <https://pypi.org/project/hepdata-validator/>`_ using ``pip``
4949
$ pip install --user hepdata-validator
5050
$ hepdata-validate --help
5151
52-
Install from GitHub (for developers) in a `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_:
52+
If you would like to use LibYAML, you may need an additional step if running on an M1 Mac, to ensure pyyaml is built
53+
with the LibYAML bindings. Run the following after installing LibYAML via Homebrew:
54+
55+
.. code:: bash
56+
57+
$ LDFLAGS="-L$(brew --prefix)/lib" CFLAGS="-I$(brew --prefix)/include" pip install --global-option="--with-libyaml" --force pyyaml
58+
59+
60+
Developers
61+
==========
62+
Developers should install from GitHub in a `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_:
5363

5464
.. code:: bash
5565
5666
$ git clone https://github.com/HEPData/hepdata-validator
5767
$ cd hepdata-validator
5868
$ python3 -m venv ~/venv/hepdata-validator
5969
$ source ~/venv/hepdata-validator/bin/activate
60-
(hepdata-validator) $ pip install --upgrade -e .[tests]
61-
(hepdata-validator) $ pytest testsuite
70+
(hepdata-validator) $ pip install --upgrade -e ".[tests]"
71+
72+
Tests should be run both with and without LibYAML, as error messages from the different YAML parsers vary:
73+
74+
.. code:: bash
6275
76+
(hepdata-validator) $ USE_LIBYAML=True pytest testsuite
77+
(hepdata-validator) $ USE_LIBYAML=False pytest testsuite
6378
6479
Usage
6580
-----

0 commit comments

Comments
 (0)