S/W 등록
소프트웨어 등록 이용 안내
DataON의 CANVAS 분석 서비스 사용을 위해서는 분석 서비스 신청이 필요합니다.
분석 서비스 신청이 승인되지 않은 상태에서는 CANVAS 홈에 접속할 수 없습니다.
◎ 소프트웨어 메뉴 화면
개발한 소프트웨어를 DataON에 등록하여 다른 연구자들과 공유 및 활용할 수 있습니다.
CANVAS의 "①My CANVAS" 또는 "①Software"메뉴에서 "②소프트웨어 등록" 버튼을 클릭하면 소프트웨어 등록 화면으로 연결됩니다.
등록 가능한 소프트웨어는 3가지로, 애플리케이션 / 워크플로우 / 소스코드가 있습니다.
◎ 소프트웨어 등록
소프트웨어 등록에 앞서 등록할 소프트웨어에 관한 ①기본 정보를 등록합니다.
소프트웨어 기본 정보 등록 단계는 필수 입력 단계로 모든 내용을 입력해야 소프트웨어 등록이 가능합니다.
①소프트웨어 구분/ 이름/ 버전/ 썸네일 정보/ 간략 설명/ 상세 설명 정보를 입력합니다.
ⓐ소프트웨어 구분에서는 애플리케이션/ 워크플로우/ 소스 코드 중 등록할 소프트웨어 형태를 선택합니다.
선택한 소프트웨어 형태에 따라 기본 정보 등록 이후 절차가 달라집니다.
버전 정보 입력 시, 같은 이름의 소프트웨어가 있다면 해당 소프트웨어보다 높은 버전을 입력하여야 합니다.
썸네일 정보에서는 소프트웨어의 아이콘에 사용할 이미지 파일을 첨부합니다.
하단의 소프트웨어 등록 시 ②주의사항을 반드시 숙지한 후 등록을 진행하는 것을 권장해 드립니다.
"③소프트웨어 기본 정보 등록" 버튼을 클릭하면 기본 정보가 등록되며 선택한 소프트웨어의 등록 화면으로 연결됩니다.
1. 기본 정보 입력 단계
1단계는 "①기본 정보" 입력 단계로, 앞서 소프트웨어 기본 정보 등록 과정에서 입력한 ②기본 정보가 자동으로 입력됩니다.
②기본 정보가 정확히 입력되었는지 확인한 후, 하단의 ③주의사항을 숙지하고 "④저장하고 다음으로" 버튼을 클릭하면 다음 단계로 넘어갑니다.
입력 내용에 수정이 필요한 경우, 해당 단계에서 수정 후 "④저장하고 다음으로" 버튼을 클릭하면 수정 내용이 저장됩니다.
"⑤삭제" 버튼을 클릭하면 현재 입력 중인 소프트웨어 정보가 삭제되고 등록이 취소됩니다.
2. 상세정보 입력 단계
2단계는 ①상세정보 입력 단계로, 애플리케이션의 상세정보를 입력합니다.
카테고리/ 키워드/ 담당자 정보/ 개발자 정보/ 메뉴얼 정보
상세정보는 모든 ②입력란이 필수 입력란으로 반드시 입력해야 소프트웨어 등록이 가능합니다.
카테고리는 다중 선택이 가능합니다.
개발자 정보 입력 시, 개발자가 다수일 경우, 입력란 우측 [+버튼]버튼을 클릭하여 추가 입력란을 생성할 수 있습니다.
매뉴얼은 URL 혹은 파일 첨부를 통하여 입력할 수 있습니다.
모든 정보를 입력한 뒤, 하단의 "④저장하고 다음(③이전)으로" 버튼을 클릭하면 다음(이전) 단계로 넘어갑니다.
하단의 "⑤삭제" 버튼을 클릭하면 현재까지 입력한 소프트웨어 정보가 삭제되고 등록이 취소됩니다.
3. 실행 정보 입력 단계
3단계는 ①실행 정보 입력 단계로, 사용자가 애플리케이션을 실행할 때 필요한 정보를 입력합니다.
작성 언어 & 실행 언어/ 실행 파일 경로/ 실행 자원(CPU only or CPU&GPU)/ CPU & GPU 정보/ Conda 가상환경 정보
실행 정보 역시 모든 ②입력란이 필수 입력란으로 반드시 입력해야 소프트웨어 등록이 가능합니다.
작성/실행 언어의 경우, 목록에 존재하지 않는 언어로 개발된 애플리케이션은 등록할 수 없습니다.
애플리케이션 실행파일은 선택한 작성/실행 언어와 동일한 언어를 선택해야 합니다.
ⓐ애플리케이션 실행 자원은 CPU only와 With CPU, GPU 중에 하나를 선택한 뒤, 하단의 CPU, GPU 정보 입력란에 필요한 자원 수를 입력합니다.
Conda 가상환경(Env)는 CANVAS내에서 활용되는 분석환경의 기본 단위가 됩니다.
Conda 가상환경 입력 시, “ⓑ공개 Conda 가상환경 관리”또는 ”ⓒ내 Conda 가상환경”탭을 선택하여 입력할 수 있습니다.
“ⓑ공개 Conda 가상환경 관리”를 선택하였을 경우 : 공개 Conda 가상환경 목록 중 하나를 선택
”ⓒ내 Conda 가상환경”를 선택하였을 경우 : "내 Conda 가상환경 동기화" 버튼을 클릭하면 현재 로컬 Conda 가상환경을 불러올 수 있습니다.
내 Conda 가상환경 선택시 6.검증에서 Conda 검증이 필요합니다.
jupyterLab을 활용해 새로운 Conda 가상환경을 생성할 수 있습니다.
모든 정보를 입력한 뒤, 하단의 "④저장하고 다음(③이전)으로" 버튼을 클릭하면 다음(이전) 단계로 넘어갑니다.
하단의 "⑤삭제" 버튼을 클릭하면 현재까지 입력한 소프트웨어 정보가 삭제되고 등록이 취소됩니다.
4. 포트 정보 입력 단계
입력포트 (※ 예약어 : -import)
※ 입력포트 추가 시 : 입력된 포트명이 소스코드 내 argparse의 argument와 매핑되어 동작됨.
(이때, 포트명은 반드시 “-”를 앞에 붙여서 “-[포트명]”과 같이 입력해주어야 함.)
출력 포트 (※ 예약어 : -prePath)
애플리케이션 실행결과는 "결과 파일명 또는 폴더명" 항목에 작성자가 지정해야 합니다.
(이때, 포트명은 반드시 ‘-’를 앞에 붙여서 “-[포트명]”과 같이 입력해주어야 하며, 입력된 포트명은 애플리케이션 실행 시 코드 내 argparse의 argument와 매핑되어야 함.)
※ 애플리케이션 실행파일에서 작성한 출력포트 -prePath는 워크플로우에서 애플리케이션 실행 시 생성되는 결과물이 저장되는 상위 경로(~/workspace/MyCanvas/workflow/애플리케이션_이름_version_VERIFY/애플리케이션_이름_version/result)로 시스템에서 자동으로 생성 됨.
결과파일 경로는 디폴트로 –prePath가 시스템에서 자동 설정되며, 결과파일 명은 위와 같이 “convert_result.csv”로 소스코드와 동일하게 입력해야 합니다. 그리고 애플리케이션이 실행되면 애플리케이션 이름에 “result”라는 디렉토리가 생성되고, 그 하위에 결과파일 “convert_result.csv”이 저장됩니다.
예시) “[-prePath 경로]/convert_result.csv”
4단계는 ①포트 정보 입력 단계로, 애플리케이션 실행 시에 필요한 ②입력 포트와 출력 포트 정보를 입력합니다.
포트 명/ 포트 타입/ 샘플 데이터(입력 포트)/ 포트 설명/ 결과 파일 경로(출력 포트)
"③+입력 포트 추가" 혹은 "③+출력 포트 추가" 버튼을 클릭하면 ③포트 정보 입력창이 나타납니다.
③포트 명과 포트 설명, 포트 타입은 포트 종류와 상관없이 공통으로 입력해야 합니다.
입력 포트의 경우, ⓐ포트 타입에 맞는 가능한 파일 확장자와 일치하는 샘플 데이터 파일을 선택해야 합니다.
“File” 선택 시 입력한 확장자에 해당하는 샘플 파일을 선택해야 합니다
“Folder” 선택 시 샘플 파일이 포함된 경로를 지정해야 합니다.
“Text” 선택 시 샘플 문자열을 입력 할 수 있습니다.
출력 포트의 경우, ⓑ결과 폴더(혹은 파일) 경로를 입력해야 합니다.
결과 파일은“/MyCanvas/workflow/{워크플로우 제목}/{애플리케이션 명_{버전}}/result/” 하위에 생성됩니다.
파일 지정 해당 경로에 지정한 파일이 생성됩니다.
폴더 지정 해당 폴더에 파일 목록이 생성됩니다.
폴더일 경우 “/”로 끝나야 합니다.
모든 내용을 입력한 뒤, 하단의 "ⓒ저장" 버튼을 클릭하면 해당 ④포트 정보가 입/출력포트 정보란에 표시됩니다.
저장한 포트 정보의 수정을 원하는 경우, 각 ④포트 정보 우측의 "[작성버튼이미지]"버튼을 클릭하면 해당 포트에 대한 포트 정보 입력창에서 정보를 수정할 수 있습니다.
저장한 포트 정보의 삭제를 원하는 경우, 각 ④포트 정보 우측의 "[삭제버튼이미지]"버튼을 클릭하면 해당 포트 정보가 삭제됩니다.
모든 정보를 입력한 뒤, 하단의 "⑥저장하고 다음(⑤이전)으로" 버튼을 클릭하면 다음(이전) 단계로 넘어갑니다.
하단의 "⑦삭제" 버튼을 클릭하면 현재까지 입력한 소프트웨어 정보가 삭제되고 등록이 취소됩니다.
5. 공개정보 입력 단계
5단계는 ①공개정보 입력 단계로, 등록할 소프트웨어의 라이선스와 공개 여부에 관한 정보를 입력합니다.
실행 파일 공개 여부/ 공개 여부 선택/ 소프트웨어 라이선스
공개정보 역시 모든 ②입력란이 필수 입력란으로 반드시 입력해야 소프트웨어 등록이 가능합니다.
선택 가능한 소프트웨어 라이선스 목록 중에 사용할 소프트웨어 라이선스를 선택합니다.
목록에 나타나지 않은 다른 라이선스를 선택하고자 하는 경우, 하단의 "ⓑ기타"를 선택하여 입력합니다.
소프트웨어 라이선스에 대한 추가 정보가 필요한 경우, "ⓐ소프트웨어 라이선스 안내" 버튼을 클릭하면 소프트웨어 라이선스에 대한 정보를 확인할 수 있습니다.
모든 정보를 입력한 뒤, 하단의 "④저장하고 다음(③이전)으로" 버튼을 클릭하면 다음(이전) 단계로 넘어갑니다.
하단의 "⑤삭제" 버튼을 클릭하면 현재까지 입력한 소프트웨어 정보가 삭제되고 등록이 취소됩니다.
6. 검증 단계
6단계는 ①검증 단계로, 등록할 애플리케이션이 정상적으로 실행되는지를 확인합니다.
"②애플리케이션 검증 수행" 버튼을 클릭하면 이전 단계에서 입력한 입력 포트의 샘플 데이터에 대해서 애플리케이션이 실행됩니다.
정상적으로 애플리케이션이 실행되지 않는 경우, 다음 단계로 넘어갈 수 없습니다.
화면 하단에서는 애플리케이션 등록 시에 입력한 ③Conda 가상환경 정보를 확인할 수 있습니다.
입력한 가상환경의 ⓐYML 파일과 ⓑ패키지 정보를 확인할 수 있습니다.
애플리케이션의 정상적인 실행 여부 검증이 완료된 뒤, 하단의 "⑤다음(④이전)으로" 버튼을 클릭하면 다음(이전) 단계로 넘어갑니다.
"⑥삭제" 버튼을 클릭하면 현재까지 입력한 소프트웨어가 삭제되고 등록이 취소됩니다.
7. 작성 완료
7단계는 ①작성 완료 단계로, 소프트웨어 등록을 위한 정보 입력이 완료됨을 알려줍니다.
소프트웨어 등록 정보 작성 완료 이후, 소프트웨어가 CANVAS에서 서비스되기 위해 관리자에게 등록 승인 요청이 필요합니다.
중앙의 "②등록 승인 요청" 버튼을 클릭하면 관리자에게 승인 요청 알림이 전송됩니다.
승인에는 최소 1일에서 3일(주말 제외)의 시간이 소요됩니다.
◎ 워크플로우 등록
소프트웨어 구분 중 워크플로우를 선택한 경우, 소프트웨어 등록 절차는 총 5단계로 진행됩니다.
기본 정보 - 상세정보 -워크플로우 선택 - 공개정보 - 작성 완료
기본정보, 상세정보, 공개정보 입력 단계 및 작성 완료 단계는 애플리케이션 등록 과정과 같습니다.
각 단계를 클릭하여 해당 단계로 이동할 수 있습니다.
1/2. 기본 정보/상세정보 입력 단계
애플리케이션 등록과 같습니다.
상단의 애플리케이션 등록 가이드를 참고하세요.
3. 워크플로우 선택 단계
3단계는 워크플로우 선택 단계로, 등록할 워크플로우를 선택합니다.
CANVAS에서 작성한 워크플로우 중, 등록할 ⓐ워크플로우를 선택하면 하단의 ⓑGUI에서 해당 워크플로우 내용을 확인할 수 있습니다.
워크플로우 ⓑGUI 내에서 확대/ 축소/ 메모 노드 추가 등의 기능을 사용할 수 있습니다.
워크플로우 선택을 완료한 뒤, 하단의 "④저장하고 다음(③이전)으로" 버튼을 클릭하면 다음(이전) 단계로 넘어갑니다.
하단의 "⑤삭제" 버튼을 클릭하면 현재까지 입력한 워크플로우 정보가 삭제되며 등록이 취소됩니다.
4/5. 공개정보 입력 단계 / 작성 완료
애플리케이션 등록과 같습니다.
상단의 애플리케이션 등록 가이드를 참고하세요.
◎ 소스코드 등록
소프트웨어 구분 중 소스 코드를 선택한 경우, 소프트웨어 등록 절차는 총 5단계로 진행됩니다.
기본 정보 - 상세정보 - 소스 코드 선택 - 공개정보 - 작성 완료
기본 정보, 상세정보, 공개정보 입력 단계 및 작성 완료 단계는 애플리케이션 등록 과정과 같습니다.
각 단계를 클릭하여 해당 단계로 이동할 수 있습니다.
1/2. 기본 정보/상세정보 입력 단계
애플리케이션 등록과 같습니다.
상단의 애플리케이션 등록 가이드를 참고하세요.
3. 소스코드 선택 단계
3단계는 소스 코드 선택 단계로, 등록할 소스 코드를 마이 드라이브에서 선택합니다.
마이 드라이브에 저장된 여러 파일 중 등록할 소스 코드 파일을 선택하면 좌측 화면에서 미리보기를 확인할 수 있습니다.
미리보기를 통해 확인한 뒤, 소스 코드 선택을 완료하면 하단의 ③선택된 파일 목록에 선택한 파일 정보가 입력됩니다.
소스 코드 등록 전, 하단의 소프트웨어 등록 시 ④유의사항을 반드시 숙지하고 진행하는 것을 권장해 드립니다.
소스 코드 선택을 완료한 뒤, 하단의 "⑥저장하고 다음(⑤이전)으로" 버튼을 클릭하면 다음(이전) 단계로 넘어갑니다.
하단의 "⑦삭제" 버튼을 클릭하면 현재까지 입력한 소스 코드 정보가 삭제되며 등록이 취소됩니다.
4/5. 공개정보 입력 단계 / 작성 완료
애플리케이션 등록과 같습니다.
상단의 애플리케이션 등록 가이드를 참고하세요
Last updated
