Projects

General#

1. What are Projects in this system?

   Projects are dedicated areas for managing your code. They allow you to add, remove, share, and organize your files. Each project is equipped with version control, meaning all your files are backed up to a remote Git repository.

2. Why should I use Projects?

   Projects provide a structured way to manage your code, and the built-in version control ensures that your work is always backed up. You can also collaborate with others by sharing projects.

3. What’s the difference between Projects and the Data repository?

   Projects are meant for code and code-related files. They are not designed for storing large datasets. For data storage, it’s recommended to use the Data repository.

4. How do I set up Projects for the first time?

   You only need to set up Projects once to ensure your configuration is correct. Use the pvc setup command and follow the prompts to configure your username and email.

Creating and Managing Projects#

5. How do I create a new project?

   You can create a new project using the pvc create command. It will prompt you for the project title, a unique short name, and the path to store the project.

6. What is the “short name” for a project, and why is it important?

   The short name is a unique identifier for your project and cannot contain spaces or special characters. It helps distinguish your projects from each other.

7. Are all files in a project backed up automatically?

   By default, all JupyterLab notebooks saved in the project directory are automatically added to the Git repository. You can change this behavior by removing the .auto file in the project directory. Other files need to be added manually to the Git repository.

8. How can I add files to a project?

   You can add files to a project using the pvc add command. To add all files in the current directory, use pvc add .. For specific files, use pvc add filename.

9. How do I ignore specific files in a project?

   To ignore files, you can create a .gitignore file in the project directory and list the files you want to exclude from version control.

10. Can I remove files from a project, and what happens to previous versions?

    Yes, you can remove files from a project using the pvc remove command. When you delete a file, previous versions are retained in the Git repository.

11. How do I delete a project?

    Use the pvc delete command to delete a project. It removes the project from both the local and remote Git repositories.

12. How can I share a project with others?

    You can share a project with other users by adding them as collaborators using the pvc share command.

13. How do I clone an existing project?

    To clone an existing project to your current directory, use the pvc clone command, specifying the project’s location.

Version Control and Collaboration#

14. What’s the purpose of pulling changes from a project?

    Pulling changes from a project is useful when you want to update your local version with the latest changes made by other collaborators. It ensures you have the most up-to-date version of the project.

15. What should I do if the pull command fails due to conflicts?

    If conflicts occur during a pull, you have a few options:

• Use pvc pull --overwrite to overwrite your local changes with the remote version (local changes will be lost).
• Use pvc pull --stash to stash your local changes temporarily and then pull the remote changes (local changes are saved in a stash).

Projects in JupyterLab#

16. How can I manage my project using JupyterLab?

    JupyterLab is integrated with the Projects repository. You can create new JupyterLab notebooks within a project, edit existing notebooks, and commit your changes to the Git repository.

17. What happens when I create a new JupyterLab notebook in a project directory?

    When you create a new notebook, it’s not automatically tracked by Git. You need to add it to the repository manually.

18. How do I track changes in JupyterLab?

    To track changes in JupyterLab, add the file to the Git repository using the + button next to the file name. Then, provide a commit message and click “Commit” to save changes to the local repository.

19. How do I view the history of changes in JupyterLab?

    Click the “History” button in JupyterLab to view a history of all changes made to a notebook.

User Interface#

20. How can I access and edit my projects using the User Interface?

    You can browse your projects and edit files in your browser using the User Interface. It’s powered by Gitea, providing easy access to your repositories.

Version Control and Backup#

21. How often are my project files backed up to the remote Git repository?

    Your project files are continuously backed up to the remote Git repository every time changes are committed. This ensures that even the latest changes are safe and recoverable.

22. What happens if I accidentally delete a file in my project? Can I recover it from the backup?

    Yes, you can recover accidentally deleted files from the backup. The Git repository stores the history of your project files, allowing you to retrieve previous versions or deleted files.

23. Is there a limit to the number of projects I can create and manage?

    There is no strict limit to the number of projects you can create. However, it’s recommended to manage your projects efficiently and consider organizing related code into fewer projects when appropriate.

24. Can I move a project to a different location or directory after it’s created?

    While it’s possible to move a project to a different directory, it’s recommended to do so with caution, as it may affect the paths referenced in your code. Adjust your code references accordingly after moving a project.

Collaboration#

25. Can multiple users work on the same project simultaneously in real-time?

    Multiple users can collaborate on a project, but real-time simultaneous editing within JupyterLab may lead to conflicts. Users should coordinate their work and consider using version control features to manage changes effectively.

26. What happens if multiple collaborators make changes to a project simultaneously, leading to conflicts?

    If conflicts occur when multiple collaborators make changes simultaneously, you will need to resolve these conflicts during the pull process. Use the provided options to determine how to merge or handle the conflicting changes.

Data Handling#

27. Can I store large datasets in a project?

    It’s not recommended to store large datasets in a project. Projects are intended for code and code-related files. For large datasets, consider using the Data repository or other suitable data storage solutions.

28. What is the default maximum file size for files in a project?

    By default, files larger than 100MB cannot be stored in the Projects repository. If you need to store larger files, please contact the system administrator for guidance.

Advanced Commands#

29. Can I use Git commands directly in the project directory, bypassing the ‘pvc’ wrapper?

    Yes, you can use Git commands directly within the project directory. The ‘pvc’ command is a thin wrapper around Git, and you have the option to utilize Git commands directly for advanced version control operations.

30. Can I use the Projects repository with other Git services?

    Yes, you can use the Projects repository with other Git services. You can clone a project to your local machine and push changes to other Git services. However, it’s recommended to use the Projects repository for version control and backup.