Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/sphinx/source/_static/forkme_ribbon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/sphinx/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{% block document %}
{{super()}}
<a href="https://github.com/ClusterMonteCarlo/CMC-COSMIC">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ pathto('_static/forkme_ribbon.png', 1) }}" alt="Fork me on GitHub">
</a>
{% endblock %}
{% set css_files = css_files + ['_static/cosmic-docs.css'] %}
Expand Down
15 changes: 15 additions & 0 deletions docs/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,23 @@
'IPython.sphinxext.ipython_console_highlighting',
'IPython.sphinxext.ipython_directive',
'numpydoc',
'sphinx_copybutton',
]

# -- sphinx-copybutton --------------------------
# Strip IPython "In [1]:" / "Out[1]:" prompts and shell prompts from copied
# code blocks so users can paste snippets directly into a Python shell.
copybutton_prompt_text = r"In \[\d*\]: |\s*\.{3,}: |Out\[\d*\]: |\$ |> "
copybutton_prompt_is_regexp = True
copybutton_only_copy_prompt_lines = False
copybutton_remove_prompts = True

# -- IPython directive --------------------------
# Don't fail the build when an executed example emits a stray warning. Newer
# pandas raises chained-assignment warnings from inside COSMIC's
# InitialCMCTable.write, which would otherwise abort the whole docs build.
ipython_warning_is_error = False

# -- Extensions ---------------------------------------------------------------

# -- autodoc ------------------------------------
Expand Down
154 changes: 106 additions & 48 deletions docs/sphinx/source/inifile/index.rst

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions examples/KingProfile.ini
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,11 @@ mxns = 3.0
; default = 0.5
rembar_massloss = 0.5

; wd_mass_lim determines if the maximum white dwarf mass is limited to
; the chandraekhar mass during merger induced collapse.
; 1 implements the limit, while 0 does not
; default = 1
wd_mass_lim = 1


;;;;;;;;;;;;;;;;;;;;;;;;;;
Expand Down
8 changes: 5 additions & 3 deletions examples/PlummerSphere.ini
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,11 @@ TIDAL_CAPTURE = 0
; default = 0 (coll)
CO_TDE = 0

; Allow for tidal capture in single-single interactions for non-giant stars (0=off, 1=on)
; Follows prescription in Ye et al. 2022
; default = 0
; Enable tidal captures during single-single interactions
; Uses polytropic stellar models for stars
; Uses cross sections from Kim & Lee, 1999
; Only activated if SS_COLLISION = 1
; default = 0 (off)
TC_POLYTROPE = 0

; Allow for tidal capture (a multiple of the set factor of the pericenter) during single-single collision ; 1=off, greater than 1 sets different multiplyers
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sphinx-bootstrap-theme >= 0.6
sphinxcontrib-programoutput
sphinxcontrib-katex
sphinx-automodapi
sphinx-copybutton
ipython
sphinx_rtd_theme
breathe
Expand Down
Loading