README

Welcome to OCaml Batteries Included

OCaml Batteries Included, or justBatteries, is a community-maintained foundation library for your OCaml projects. Batteries

• defines a standard set of libraries which may be expected on every compliant installation of OCaml;

• organizes these libraries into a hierarchy of modules, with a single source of documentation; and

• provides a consistent API for otherwise independent libraries.

Documentation

Building Batteries

Requirements

You will need the following libraries:

• OCaml >= 3.12.1

• Findlib >= 1.5.3

• GNU make

• OUnit to build and run the tests (optional)

• qtest >= 2.0.1 to build and run the tests (optional)

• ocaml-benchmark to build and run the performance tests (optional)

Configuration and Installation

To install the full version of Batteries, execute

$ make all$ make test               [ optional ]$ sudo make install$ make doc                [ optional ]$ sudo make install-doc   [ optional ]

If you want the documentation installed elsewhere, set thisbefore starting the build process because this location is stored in theBatteries_config module generated during compilation.

$ export DOCROOT=/path/to/new/docroot/

To disable native compilation:

$ export BATTERIES_NATIVE=false

To disable building of native shared libraries:

$ export BATTERIES_NATIVE_SHLIB=false

Using Batteries

To get started using Batteries at the toplevel, copy theocamlinit file to~/.ocamlinit:

$ cp ocamlinit ~/.ocamlinit

If you already have findlib in your~/.ocamlinit, you only need the last line in our ocamlinit to load batteries.

More usage help available on thebatteries-included wiki.

ExtLib Compatibility

If your project currently usesExtLib, most likely you can just change-package extlib to-package batteries and addopen Extlib to the top of any extlib-using modules. Batteries' modules are all named BatFoo to differentiate them from extlib's modules, so one can use Batteries and ExtLib in the same project.

COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not have a corresponding module in batteries at the moment.

Extending Batteries

See theguidelines wiki page.

If you use emacs, the filebatteries_dev.el has extra highlighting to support writing quicktests.

1. num
2. ocamlfind>= "1.5.3"
3. camlp-streams
4. ocaml>= "4.05" & < "5.4"
5. dune>= "2.7"

1. odocwith-doc
2. benchmarkwith-test & >= "1.6"
3. qcheckwith-test & >= "0.9" & < "0.14"
4. qtestwith-test & >= "2.5"

1. acp4
2. acpc>= "2.0.0"
3. bookaml
4. bst>= "5.0.0"
5. clangml< "4.0.0"
6. cpm>= "4.0.0"
7. daft>= "0.0.4"
8. expect
9. fasmifra
10. fstar
11. gen-bs
12. get_line>= "4.0.0"
13. goblint>= "2.0.0"
14. goblint-cil>= "1.8.0" & < "2.0.0"
15. grib< "0.11.0"
16. hts_shrink
17. jasmin
18. jhupllib>= "0.2.2"
19. karamel
20. kmt
21. kremlin< "transition"
22. lbvs_consent
23. line_oriented
24. linwrap
25. liquid_syntax
26. markdown
27. mmo
28. molenc< "15.4.0" | >= "16.5.0"
29. monadlib
30. mutf8
31. obandit
32. odnnr
33. omlr
34. oplsr
35. oranger
36. orf
37. orrandomForest>= "3.0.0"
38. orsvm_e1071
39. orxgboost
40. pa_comprehension
41. pardi
42. pds-reachability
43. portia
44. ppx_nanocaml
45. rankers
46. remu_ts
47. spirv
48. svmwrap
49. telegraml
50. typeid
51. vcardgen>= "1.1"

1. ocaml-option-no-flat-float-array