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

suggestions for improving the README File #18

Open
yulijia opened this issue Jul 7, 2024 · 2 comments
Open

suggestions for improving the README File #18

yulijia opened this issue Jul 7, 2024 · 2 comments

Comments

@yulijia
Copy link

yulijia commented Jul 7, 2024

  1. It is better to include a complete step-by-step guide on how to run the example (the user needs to download the GitHub repository, not just install BidCell via pip).
  2. It is better to include the path of the example params_small_example.yaml; otherwise, I have to check each folder to find it.
    https://github.com/SydneyBioX/BIDCell/tree/main/bidcell/example_params
  3. If we can also provide a suggestion on how to run it on a specific GPU, it will benefit our group as well.
    CUDA_VISIBLE_DEVICES=3; python example_small.py

I will keep updating this list.

xhelenfu added a commit that referenced this issue Jul 16, 2024
@xhelenfu
Copy link
Collaborator

Thanks for your suggestions! I've incorporated them into the latest README file.

@yulijia
Copy link
Author

yulijia commented Jul 25, 2024

  1. I also need a clear explanation of the headers for the reference file and marker gene file.

what are the meaning of ct_idx,cell_type,atlas?

the ct_idx should start with 0 or 1?

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

No branches or pull requests

2 participants