Skip to content

Commit

Permalink
Add line to server instructions, fix spelling mistake
Browse files Browse the repository at this point in the history
  • Loading branch information
abigailalexander committed Jan 3, 2024
1 parent 906b7a6 commit 6a52ec6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/how-to/run-a-server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ You can run up a simulation server like this::

pipenv run python -m coniql

Then you can test the connection with the graphiql interface:
You can also include the `--cors` argument when starting the coniql server, which allows Cross Origin Resource Sharing.
Once the server is started you can test the connection with the graphiql interface:

http://localhost:8080/graphiql

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/performance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The primary method used for investigating Coniql's performance has been `py-spy
This is a sampling profiler that can output speedscope-format data, which can then be viewed in the very nice
`Speedscope web UI <https://www.speedscope.app/>`_.

The profiles have been generates by first installing ``py-spy``, then running the :doc:`benchmark` tests,
The profiles have been generated by first installing ``py-spy``, then running the :doc:`benchmark` tests,
modifying the Bash script to launch ``py-spy``, for example::

CMD2="sleep 2;source $CONIQL_DIR/bin/activate;py-spy record --format speedscope --output speedscope-$(date +"%Y-%m-%d-%H:%M:%S") coniql"
Expand Down

0 comments on commit 6a52ec6

Please sign in to comment.