Skip to main content
Documentation Build Status Build Status

Cerulean

Cerulean is a Python 3 library for talking to HPC clusters and supercomputers. It lets you copy files between local and SFTP filesystems using a pathlib-like API, it lets you start processes locally and remotely via SSH, and it lets you submit jobs to schedulers such as Slurm and Torque/PBS.

Documentation and Help

Cerulean can be installed as usual using pip:

pip install cerulean

Instructions on how to use Cerulean can be found in the Cerulean documentation.

Code of Conduct

Before we get to asking questions and reporting bugs, we’d like to point out that this project is governed by a code of conduct, as described in CODE_OF_CONDUCT.rst, and we expect you to adhere to it. Please be nice to your fellow humans.

Questions

If you have a question that the documentation does not answer for you, then you have found a bug in the documentation. We’d love to fix it, but we need a bit of help from you to do so. Please do the following:

  1. use the search functionality here to see if someone already filed the same issue;

  2. if your issue search did not yield any relevant results, make a new issue;

  3. apply the “Question” label; apply other labels when relevant.

We’ll answer your question, and improve the documentation where necessary. Thanks!

Bugs

Like most software, Cerulean is made by humans, and we make mistakes. If you think you’ve found a bug in Cerulean, please let us know! Reporting bugs goes as follows.

  1. Use the search functionality here to see if someone already filed the same issue.

  2. If your issue search did not yield any relevant results, make a new issue. Please explain: - what you were trying to achieve, - what you did to make that happen, - what you expected the result to be, - what happened instead. It really helps to have the actual code for a simple example that demonstrates the issue, but excerpts and error messages and a description are welcome too.

  3. Finally, apply any relevant labels to the newly created issue.

With that, we should be able to fix the problem, but we may ask for some more information if we can’t figure it out right away.

Development

More information for Cerulean developers may be found in the Cerulean documentation.

License

Copyright (c) 2018-2019 The Netherlands eScience Center and VU University Amsterdam Copyright (c) 2024-2025 The Netherlands eScience Center

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Metadata

Release files for cerulean 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cerulean 1.0.0
File Size Uploaded Provenance Actions
cerulean-1.0.0.tar.gz 50.9 kB Without provenance Details for cerulean-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cerulean 1.0.0
File Interpreter ABI Platform Actions
cerulean-1.0.0-py3-none-any.whl Python 3 none any Details for cerulean-1.0.0-py3-none-any.whl

Total release size: 110.7 kB

Release files / cerulean-1.0.0.tar.gz

Download URL cerulean-1.0.0.tar.gz
Size 50.9 kB
Tags Source
SHA-256 checksum
How to use checksums
e5aa5ff10a3124521ea1cfe4872a858c96267edada1cc0d16e659f7a91e077c8
BLAKE2b-256 checksum
How to use checksums
167c5b2dc5c021151d8b8b30b532ce0e1fa94e6d3c000f23cf1e2da20b747253
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.12

Release files / cerulean-1.0.0-py3-none-any.whl

Download URL cerulean-1.0.0-py3-none-any.whl
Size 59.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d8973826532649868dec6d870f2f9eac69b944dec7e0a1e2d9daf90424fbc8bc
BLAKE2b-256 checksum
How to use checksums
97cb1e67e6b59a34d524755a180a24ac9f761d5831f9bf269c58d83aca5b4ac9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.12

Security for cerulean 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page