Skip to content

Commit

Permalink
Merge pull request #399 from itamarst/highlight-scientific-computing
Browse files Browse the repository at this point in the history
Highlight Trio and scientific computing.
  • Loading branch information
itamarst authored Apr 25, 2019
2 parents 7510fb8 + 7f90b52 commit c03c965
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Eliot supports a range of use cases and 3rd party libraries:

* Logging within a single process.
* Causal tracing across a distributed system.
* Scientific computing, with `built-in support for NumPy and Dask <https://eliot.readthedocs.io/en/stable/usecases/scientific-computing.html>`_.
* `Asyncio coroutines <https://eliot.readthedocs.io/en/stable/generating/asyncio.html>`_ and the `Twisted networking framework <https://eliot.readthedocs.io/en/stable/generating/twisted.html>`_.
* Scientific computing, with `built-in support for NumPy and Dask <https://eliot.readthedocs.io/en/stable/scientific-computing.html>`_.
* `Asyncio and Trio coroutines <https://eliot.readthedocs.io/en/stable/generating/asyncio.html>`_ and the `Twisted networking framework <https://eliot.readthedocs.io/en/stable/generating/twisted.html>`_.

Eliot is only used to generate your logs; you will might need tools like Logstash and ElasticSearch to aggregate and store logs if you are using multiple processes across multiple machines.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Eliot supports a range of use cases and 3rd party libraries:
* Logging within a single process.
* Causal tracing across a distributed system.
* Scientific computing, with :doc:`built-in support for NumPy and Dask <scientific-computing>`.
* :doc:`Asyncio coroutines <generating/asyncio>` and the :doc:`Twisted networking framework <generating/twisted>`.
* :doc:`Asyncio and Trio coroutines <generating/asyncio>` and the :doc:`Twisted networking framework <generating/twisted>`.

Eliot is only used to generate your logs; you might still need tools like Logstash and ElasticSearch to aggregate and store logs if you are using multiple processes across multiple machines.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/outputting/output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This ensures that no messages will be lost if logging happens during configurati


Outputting JSON to a file
--------------------
-------------------------

Since JSON is a common output format, Eliot provides a utility class that logs to a file, ``eliot.FileDestination(file=yourfile)``.
Each Eliot message will be encoded in JSON and written on a new line.
Expand Down
3 changes: 2 additions & 1 deletion docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,5 @@ You can learn more by reading the rest of the documentation, including:
* How to generate :doc:`actions <generating/actions>`, :doc:`standalone messages <generating/messages>`, and :doc:`handle errors <generating/errors>`.
* How to integrate or migrate your :doc:`existing stdlib logging messages <generating/migrating>`.
* How to output logs :doc:`to a file or elsewhere <outputting/output>`.
* Using :doc:`asyncio coroutines <generating/asyncio>`, :doc:`threads and processes <generating/threads>`, or :doc:`Twisted <generating/twisted>`.
* Using :doc:`asyncio or Trio coroutines <generating/asyncio>`, :doc:`threads and processes <generating/threads>`, or :doc:`Twisted <generating/twisted>`.
* Using Eliot for :doc:`scientific computing <scientific-computing>`.

0 comments on commit c03c965

Please sign in to comment.