CitationRecipes

Documentation for CitationRecipes.

See the Index for the complete list of documented functions and types.

The code is hosted on GitHub, with some continuous integration services to test its validity.

This repository is created and maintained by @singularitti. You are very welcome to contribute.

Installation

The package can be installed with the Julia package manager. From the Julia REPL, type ] to enter the Pkg REPL mode and run:

pkg> add CitationRecipes

Or, equivalently, via the Pkg API:

julia> import Pkg; Pkg.add("CitationRecipes")   Resolving package versions...
    Updating `~/.julia/packages/CitationRecipes/WzE2J/docs/build/developers/Project.toml`
  [7b9303d0] + CitationRecipes v0.1.0
    Updating `~/.julia/packages/CitationRecipes/WzE2J/docs/build/developers/Manifest.toml`
  [2027ae74] + BibInternal v0.3.4
  [13533e5b] + BibParser v0.2.1
  [f1be7e48] + Bibliography v0.2.19
  [d1d4a3ce] + BitFlags v0.1.7
  [7b9303d0] + CitationRecipes v0.1.0
  [944b1d66] + CodecZlib v0.7.1
  [5789e2e9] + FileIO v1.16.0
  [cd3eb016] + HTTP v1.7.4
  [83e8ac13] + IniFile v0.5.1
  [692b3bcd] + JLLWrappers v1.4.1
  [7d188eb4] + JSONSchema v1.0.1
  [e6f89c97] + LoggingExtras v1.0.0
  [739be429] + MbedTLS v1.1.7
  [4d8831e6] + OpenSSL v1.3.3
  [3cdcf5f2] + RecipesBase v1.3.3
  [ae029012] + Requires v1.3.0
  [777ac1f9] + SimpleBufferStream v1.1.0
  [69024149] + StringEncodings v0.3.6
  [3bb67fe8] + TranscodingStreams v0.9.11
  [ddb6d928] + YAML v0.4.8
  [94ce4f54] + Libiconv_jll v1.16.1+2
  [458c3c95] + OpenSSL_jll v1.1.20+0
  [8dfed614] + Test

Documentation

• STABLE — documentation of the most recently tagged version.
• DEV — documentation of the in-development version.

Project status

The package is tested against, and being developed for, Julia 1.6 and above on Linux, macOS, and Windows.

Questions and contributions

Usage questions can be posted on our discussion page.

Contributions are very welcome, as are feature requests and suggestions. Please open an issue if you encounter any problems. The Contributing page has a few guidelines that should be followed when opening pull requests and contributing code.

Manual outline

• Installation Guide
• • Install Julia
  • • Which version should I pick?
  • Install CitationRecipes
  • Update CitationRecipes
  • Uninstall and reinstall CitationRecipes
• Contributing
• • Code of conduct
  • Join the community forum
  • Improve the documentation
  • File a bug report
  • Contribute code to CitationRecipes
  • • Step 1: decide what to work on
    • Step 2: fork CitationRecipes
    • Step 3: install CitationRecipes locally
    • Step 4: checkout a new branch
    • Step 5: make changes
    • Step 6a: test your code changes
    • Step 6b: test your documentation changes
    • Step 7: make a pull request
    • Step 8: respond to comments
    • Step 9: cleaning up
• Style Guide
• • Formatting
  • • Run JuliaFormatter
    • Use the Julia extension for Visual Studio Code
• Design Principles
• • Consistency vs adherence
  • Community contribution guidelines
  • Open source contributions are allowed to start small and grow over time
  • Generic code is preferred unless code is known to be specific
  • Internal types should match the types used by users when possible
  • Trait definition and adherence to generic interface is preferred when possible
  • Macros should be limited and only be used for syntactic sugar
  • Errors should be caught as high as possible, and error messages should be contextualized for newcomers
  • Subpackaging and interface packages is preferred over conditional modules via Requires.jl
  • Functions should either attempt to be non-allocating and reuse caches, or treat inputs as immutable
  • Out-Of-Place and Immutability is preferred when sufficient performant
  • Tests should attempt to cover a wide gamut of input types
  • When in doubt, a submodule should become a subpackage or separate package
  • Globals should be avoided whenever possible
  • Type-stable and Type-grounded code is preferred wherever possible
  • Closures should be avoided whenever possible
  • Numerical functionality should use the appropriate generic numerical interfaces
  • Functions should capture one underlying principle
  • Internal choices should be exposed as options whenever possible
  • Prefer code reuse over rewrites whenever possible
  • Prefer to not shadow functions
• Troubleshooting
• • Installation problems
  • • Cannot find the julia executable
  • Loading CitationRecipes
  • • Julia compiles/loads slow

Library outline

Index