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

Document installation/use of libcantera-devel conda package #180

Closed
speth opened this issue Mar 24, 2022 · 2 comments · Fixed by #220
Closed

Document installation/use of libcantera-devel conda package #180

speth opened this issue Mar 24, 2022 · 2 comments · Fixed by #220
Labels
documentation-update An update is needed to the documentation

Comments

@speth
Copy link
Member

speth commented Mar 24, 2022

We need some documentation of:

  • What this package provides
  • What platforms are supported / current limitations
  • How to install it
  • How to use it when compiling / linking C++ (or Fortran?) applications
@speth speth added the documentation-update An update is needed to the documentation label Mar 24, 2022
@ischoegl
Copy link
Member

ischoegl commented Apr 11, 2022

I am not sure that documentation should be included at the moment. This will leave the option to discuss the future of this (at the moment likely infrequently used) package after the 2.6 release. Currently, the package doesn't work on windows (see Cantera/conda-recipes#20), and there may be additional steps required to make it useful (see Cantera/enhancements#140).

PS: One way to go about this would be to just package the headers and examples in the regular conda package by default, which would be imho the best possible outcome (i.e. same behavior as if cantera were built with the layout=conda option).

@bryanwweber
Copy link
Member

I think it would be worth documenting the cases that work, at least Linux where (I suspect) this is most likely to be used. If anything, I think we would only drop this package for Windows but leave the other two platforms that are easier to support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation-update An update is needed to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants