Skip to content

Commit 634398d

Browse files
committed
docs: Update documentation [ci skip]
Remove references to docopt and update help screen.
1 parent a339af5 commit 634398d

File tree

1 file changed

+30
-26
lines changed

1 file changed

+30
-26
lines changed

README.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ including the foundations and recent results, please see the [wiki](https://gith
4646
[Causal Dynamical Triangulations][CDT] in [C++] uses the
4747
[Computational Geometry Algorithms Library][CGAL], [Boost], [TBB], and [Eigen].
4848
Arbitrary-precision numbers and functions are by [MPFR] and [GMP].
49-
[docopt] provides a beautiful command-line interface.
5049
[Melissa E. O'Neill's Permuted Congruential Generators][PCG] library provides high-quality RNGs that pass L'Ecuyer's
5150
[TestU01] statistical tests.
5251
[doctest] provides [BDD]/[TDD].
@@ -71,7 +70,6 @@ Arbitrary-precision numbers and functions are by [MPFR] and [GMP].
7170
- [x] 3D Simplex
7271
- [x] 3D Spherical triangulation
7372
- [x] 2+1 foliation
74-
- [x] Integrate [docopt] CLI
7573
- [x] S3 Bulk action
7674
- [x] 3D Ergodic moves
7775
- [x] High-quality Random Number Generation with M.E. O'Neill's [PCG] library
@@ -211,13 +209,12 @@ along with several others.
211209

212210
## Usage
213211

214-
CDT-plusplus uses [docopt] to parse options from the help message, and so
212+
CDT-plusplus uses [program_options] to parse options from the help message, and so
215213
understands long or short argument formats, provided the short argument given
216214
is an unambiguous match to a longer one. The help message should be instructive:
217215

218216
~~~text
219217
./build/src/cdt --help
220-
cdt started at 2023-01-03.14:44:22PST
221218
Causal Dynamical Triangulations in C++ using CGAL.
222219
223220
Copyright (c) 2013 Adam Getchell
@@ -228,28 +225,38 @@ to the Metropolis algorithm. Specify the number of passes to control
228225
how much evolution is desired. Each pass attempts a number of ergodic
229226
moves equal to the number of simplices in the simulation.
230227
231-
Usage:./cdt (--spherical | --toroidal) -n SIMPLICES -t TIMESLICES [-d DIM]
232-
[--init INITIAL] [--foliate FOLIATION] -k K --alpha ALPHA
233-
--lambda LAMBDA [-p PASSES] [-c CHECKPOINT]
228+
Usage:./cdt (--spherical | --toroidal) -n SIMPLICES -t TIMESLICES
229+
[-d DIM]
230+
[--init INITIAL RADIUS]
231+
[--foliate FOLIATION SPACING]
232+
-k K
233+
--alpha ALPHA
234+
--lambda LAMBDA
235+
[-p PASSES]
236+
[-c CHECKPOINT]
237+
238+
Optional arguments are in square brackets.
234239
235240
Examples:
236241
./cdt --spherical -n 32000 -t 11 --alpha 0.6 -k 1.1 --lambda 0.1 --passes 1000
237-
./cdt --s -n32000 -t11 -a.6 -k1.1 -l.1 -p1000
242+
./cdt -s -n32000 -t11 -a.6 -k1.1 -l.1 -p1000
238243
239244
Options:
240-
-h --help Show this message
241-
--version Show program version
242-
-n SIMPLICES Approximate number of simplices
243-
-t TIMESLICES Number of timeslices
244-
-d DIM Dimensionality [default: 3]
245-
-i --init INITIAL Initial radius [default: 1]
246-
--foliate FOLIATION Foliation spacing between timeslices [default: 1]
247-
-a --alpha ALPHA Negative squared geodesic length of 1-d
248-
timelike edges
249-
-k K K = 1/(8*pi*G_newton)
250-
-l --lambda LAMBDA K * Cosmological constant
251-
-p --passes PASSES Number of passes [default: 100]
252-
-c --checkpoint CHECKPOINT Checkpoint every n passes [default: 10]
245+
-h [ --help ] Show this message
246+
-v [ --version ] Show program version
247+
-s [ --spherical ] Spherical topology
248+
-e [ --toroidal ] Toroidal topology
249+
-n [ --simplices ] arg Approximate number of simplices
250+
-t [ --timeslices ] arg Number of timeslices
251+
-d [ --dimensions ] arg (=3) Dimensionality
252+
-i [ --init ] arg (=1) Initial radius
253+
-f [ --foliate ] arg (=1) Foliation spacing
254+
-a [ --alpha ] arg Negative squared geodesic length of 1-d
255+
timelike edges
256+
-k [ --k ] arg K = 1/(8*pi*G_newton)
257+
-l [ --lambda ] arg K * Cosmological constant
258+
-p [ --passes ] arg (=100) Number of passes
259+
-c [ --checkpoint ] arg (=10) Checkpoint every n passes
253260
~~~
254261

255262
The dimensionality of the spacetime is such that each slice of spacetime is
@@ -262,8 +269,7 @@ links (in 2+1 spacetime), and the timelike faces (in 3+1 spacetime).
262269

263270
## Documentation
264271

265-
Online documentation is at <https://adamgetchell.org/CDT-plusplus/> automatically
266-
generated by [Travis-CI].
272+
Online documentation is at <https://adamgetchell.org/CDT-plusplus/>.
267273

268274
If you have [Doxygen] installed you can generate the same information
269275
locally using the configuration file in `docs\Doxyfile` by simply typing at the top
@@ -407,10 +413,8 @@ Optional:
407413

408414
- [vcpkg]'s version of [date] has an unfixed bug [#23637] which produces `use-of-uninitialized-value` in [MemorySanitizer].
409415

410-
- [docopt] also has a `use-of-uninitialized-value` bug ([#149]).
411416

412417
[#23637]: https://github.com/microsoft/vcpkg/issues/23637
413-
[#149]: https://github.com/docopt/docopt.cpp/issues/149
414418
[CDT]: https://arxiv.org/abs/hep-th/0105267
415419
[CGAL]: https://www.cgal.org
416420
[CMake]: https://www.cmake.org
@@ -425,7 +429,7 @@ Optional:
425429
[Doxygen]: http://www.doxygen.org
426430
[Homebrew]: https://brew.sh
427431
[Ninja]: https://ninja-build.org
428-
[docopt]: https://github.com/docopt/docopt.cpp
432+
[program_options]: https://www.boost.org/doc/libs/1_85_0/doc/html/program_options/tutorial.html
429433
[Mathjax]: https://www.mathjax.org
430434
[GraphViz]: https://www.graphviz.org
431435
[Eigen]: http://eigen.tuxfamily.org/index.php?title=Main_Page

0 commit comments

Comments
 (0)