Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements #289

Closed
5 of 14 tasks
mtfishman opened this issue Apr 16, 2020 · 0 comments
Closed
5 of 14 tasks

Documentation improvements #289

mtfishman opened this issue Apr 16, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mtfishman
Copy link
Member

mtfishman commented Apr 16, 2020

Here is an issue to keep track of things to do related to documentation.

  • Add instructions on installing MKL with the MKL package.
  • Add instructions for turning on/off debug checking (as explained here: Debug checks #323).
  • Add instructions on developing ITensors.jl, for example using the dev ITensors command and using Revise.
  • Add instructions on installing OhMyREPL for syntax highlighting in the REPL, and mention using the command enable_autocomplete_brackets(false) to turn off automatic matching of quotes/brackets (which can be very annoying when making primed indices).
  • Add explanations about precompiling, slow startup times, etc. In addition, add some instructions on using PackageCompiler with ITensors.jl to speed up startup times.
  • Add docs for converting ITensors to Arrays.
  • Add keyword argument options for dmrg.
  • Improve IndexSet, ITensor, MPS/MPO docs.
  • Add docs for QNs.
  • Add docs for AutoMPO, and other dmrg-related functionality.
  • Add docs for Sweeps.
  • Add more doctests.
  • Host the docs on Github and integrate documentation building and doctests with Travis.
  • Fix formatting issues.
@mtfishman mtfishman added this to the Version 0.1 milestone Apr 16, 2020
@mtfishman mtfishman added the documentation Improvements or additions to documentation label Apr 16, 2020
@mtfishman mtfishman modified the milestones: Version 0.1, v0.2.0 Oct 7, 2020
@mtfishman mtfishman self-assigned this Oct 8, 2020
@mtfishman mtfishman changed the title Finish docs Documentation improvements Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant