Skip to content

Commit d93aaf3

Browse files
authored
Merge pull request QInfer#130 from ihincks/update-duecredit-doc
Update duecredit doc
2 parents d4a1945 + 472e927 commit d93aaf3

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

doc/source/guide/citing.rst

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,32 @@ called by your script. For example, if your project can be run as
8282
$ python -m duecredit script.py
8383

8484
Alternatively, it may be more reliable to use environment variables to turn
85-
on `duecredit`_ collection, since this approach also works with Jupyter Notebook::
85+
on `duecredit`_ collection, since this approach also works with
86+
Jupyter Notebook::
8687

8788
$ export DUECREDIT_ENABLE=yes # Bash
8889
PS> $Env:DUECREDIT_ENABLE = "yes" # PowerShell
90+
91+
Or, from within an Jupyter Notebook, environment variables can be set before
92+
import using::
93+
94+
import os
95+
os.environ['DUECREDIT_ENABLE'] = 'yes'
96+
import qinfer as qi
97+
98+
Whenever it is detected that this variable is true, any uses of **Qinfer** in a
99+
given folder (even multiple distinct runs) will maintain
100+
a file in the same folder called ``.duecredit.p`` that contains
101+
a representation of your bibliography. This file is updated whenever **Qinfer**
102+
uses a module, class, or method that is appropriately tagged with a citation.
103+
104+
If you wish to see the citation compilaton of a *single* python session,
105+
you can dump the current state with::
106+
107+
qi.due.dump()
89108

90-
In either case, this will create a file called ``.duecredit.p`` containing a representation
91-
of your bibliography. To print it out in BibTeX form, use the summary functionality
92-
of `duecredit`_::
109+
On the other hand, to print it out the entire ``.duecredit.p`` collection
110+
in BibTeX form, use the summary functionality of `duecredit`_::
93111

94112
$ duecredit summary --format=bibtex
95113

0 commit comments

Comments
 (0)