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

conda: document environment files #281

Closed
oliver-sanders opened this issue Aug 4, 2021 · 8 comments
Closed

conda: document environment files #281

oliver-sanders opened this issue Aug 4, 2021 · 8 comments
Assignees
Labels
content Addition or modification of documentation

Comments

@oliver-sanders
Copy link
Member

We should document some example Cylc stack installations in the form of Conda environment files.

See cylc/cylc-admin#130

As an added bonus we could build these environments as part of the test battery to make sure they don't break.

@oliver-sanders oliver-sanders added the content Addition or modification of documentation label Aug 4, 2021
@wxtim wxtim self-assigned this Sep 1, 2021
@wxtim
Copy link
Member

wxtim commented Sep 1, 2021

I'm going to aim to add the following:

  • A most-basic environment, containing cylc-flow its dependencies
  • A "vanilla" environment, containing cylc-flow, cylc-uiserver and possibly cylc-ui (unsure how yarn and conda interact)
  • A cylc-rose environment, cylc, cylc-rose and rose

@wxtim wxtim mentioned this issue Sep 2, 2021
@wxtim wxtim added the PR-open label Sep 6, 2021
@oliver-sanders
Copy link
Member Author

We should include details/examples of the following options:

  • Python (setting version number).
  • JupyterHub (now optional via pip, soon to be a separate output on conda).
  • Configurable HTTP Proxy (optional for JupyterHub via conda, alternatives exist).
  • Jupyter Lab.
  • Jupyter Lab / Hub plugins.
  • Rose / Cylc Rose.

@wxtim
Copy link
Member

wxtim commented Sep 6, 2021

* Python (setting version number).

Easy to add. Will do.

* JupyterHub (now optional via pip, soon to be a separate output on conda).

* Configurable HTTP Proxy (optional for JupyterHub via conda, alternatives exist).

* Jupyter Lab.

* Jupyter Lab / Hub plugins.

I don't know very much about these things. Will @datamel be able to fill me in?

* Rose / Cylc Rose.

Done this

@oliver-sanders
Copy link
Member Author

oliver-sanders commented Sep 6, 2021

I'll try to take a stab at the JupyterHub and Configurable HTTP Proxy stuff when we make the next release (can't really document right now as we haven't sorted it out yet, just jotting it down so we don't forget).

The Lab stuff is literally just adding jupyterlab into the Conda deps list (no version required).

We could document a couple of the most useful plugins, the SSH authenticator will likely be essential for a few setups. We will provide our own SSH spawner though.

@wxtim
Copy link
Member

wxtim commented Sep 6, 2021

O.K. I'll add the differing python versions and JupyterLab and flesh out the docs a little by adding the commands used to create the nvs then leave the rest for now.

@wxtim
Copy link
Member

wxtim commented Oct 15, 2021

@oliver-sanders - did #293 add enough that you'd close the issue?

@wxtim wxtim removed their assignment Oct 15, 2021
@oliver-sanders
Copy link
Member Author

oliver-sanders commented Oct 15, 2021

Not yet, still need to cover the hub, configurable-http-proxy, etc, see above comments.

Will do after the next uis release (as that will change installation instructions), we haven't got a conda-forge PR up to handle the change yet.

@oliver-sanders oliver-sanders self-assigned this Oct 15, 2021
@oliver-sanders
Copy link
Member Author

Closed by #342

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Addition or modification of documentation
Projects
None yet
Development

No branches or pull requests

2 participants