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

Package Setup #1

Closed
wants to merge 11 commits into from
Closed

Package Setup #1

wants to merge 11 commits into from

Conversation

lkdvos
Copy link
Contributor

@lkdvos lkdvos commented Nov 21, 2024

Here I add the setup to convert this into a self-standing package. Some remarks:

  • Should this include a dedicated docs page, or does an explanation + example in the README suffice?

To do

  • docstrings
  • example
  • more tests (in particular for special shape combinations)

@mtfishman
Copy link
Member

Should this include a dedicated docs page, or does an explanation + example in the README suffice?

Something we could do is define an examples/README.jl in the Literate.jl format, use that to generate a docs/src/index.md file to be the splash page for the docs, and then the README.md can just be a link to docs/src/index.md (https://github.com/ITensor/ITensors.jl/blob/main/README.md). Then we don't have to choose :). (I think we can create that as a workflow in docs/makedocs.jl to make it automated though I haven't tried that yet.)

@mtfishman
Copy link
Member

This is outdated since it was superseded by #2, I'll close though we probably have to update this package to reflect changes to ITensorPkgSkeleton.jl.

@mtfishman mtfishman closed this Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants